Comments (7)
Hi @cwarnermm, thank you for the detailed clarification!
Sure, I will create a PR having the docs
folder in .gitignore
.
Shall I create another issue for finding out the root cause of why the files are being made in docs
folder instead of the dist
folder when make run
is executed?
from mattermost-developer-documentation.
That would be really great, @chessmadridista! Thank you!
from mattermost-developer-documentation.
I will be happy to take up this issue.
Please let me know in case something is amiss in my understanding and there is a reason why it is not included in .gitignore
.
from mattermost-developer-documentation.
The make run
command doesn't currently output files to the same directory as the make build
command. This is a known issue of low priority that doesn't impact generated docs output. I'd prefer to address an issue like this by updating the makefile
to ensure output is in the correct directories. Let me know if you're open to investigating the changes needed to the makefile
.
from mattermost-developer-documentation.
The
make run
command doesn't currently output files to the same directory as themake build
command. This is a known issue of low priority that doesn't impact generated docs output. I'd prefer to address an issue like this by updating themakefile
to ensure output is in the correct directories. Let me know if you're open to investigating the changes needed to themakefile
.
I have a couple of questions:
1.
...ensure output is in the correct directories...
So should the docs folder be created inside the dist
directory when make run
is executed? Or in some other directory?
2. Do docs
and dist
folder serve different purposes?
3. What is the harm in adding docs
folder to .gitignore
if it is used only for development purposes?
4. What benefits do we get if we don't add docs
folder to .gitignore
?
New solution
In config.toml file, I just need to change the path in line #8
:
publishDir = "${new_path}"
Here new_path is the placeholder. Once I know the exact path, I will replace it here.
from mattermost-developer-documentation.
@chessmadridista - The docs
and dist
- related build commands serve different purposes and produce different outputs. The make run
command (to /docs
) results in a live preview of the docs site which is very useful for local development, whereas the make build
command (to /dist
) produces full static HTML output. Our build and production pipelines make use of the latter.
I've confirmed that the /docs
directory isn't Git-version controlled, and that running make run
on a clean clone of the repository results in 900+ files, representing the output in the /docs
directory. I can appreciate what you're asking and why.
Including the docs
directory in .gitignore
is a reasonable initial step. Ideally, I'd prefer to address the known inconsistency of the make run
command outputting to a different directory as the make build
command within the makefile
. However, the Mattermost Docs team doesn't have bandwidth to take on an investigation in this area at this time.
If you're open to creating the docs PR introducing the .gitignore
update, I'm open to accepting it.
from mattermost-developer-documentation.
That would be really great, @chessmadridista! Thank you!
Hi @cwarnermm, I am happy to be of help!
#1383 has been created to investigate the Makefile
issue related to docs
and dist
.
from mattermost-developer-documentation.
Related Issues (20)
- Help Wanted: OpenSSL 3.0 legacy provider note HOT 2
- Optimize development environment setup document HOT 1
- Request for Documentation: Document title
- Help Wanted: Hamburger Menu Issue HOT 7
- "Contribute" and "Integrate & Extend" Section Content Alignment Enhancement HOT 2
- Help Wanted: Code blocks within tabbed content blocks are being double spaced HOT 1
- Request for Documentation: test HOT 1
- Help Wanted: Correct Attachments documentation HOT 2
- Request for Documentation: test doc HOT 1
- Test issue; please ignore
- Test issue
- Interactive Dialog Docs: Remove mention of nonexistent limit of dialog elements HOT 2
- Font colour wrong for Person field in dark mode HOT 2
- Enhance Documentation for Registering Plugins on the Mattermost Webapp Sidebar
- Developer setup documentation suggestions HOT 3
- Update Bootstrap from 4.0.0-beta.2 to 4.x (latest) (4.6.2)
- "Debug server-side plugins using delve" section of plugin developer workflow guide needs revision for accuracy
- Instruction for stopping docker container is given in developing Mattermost without docker documentation HOT 3
- `docs` folder is being used instead of `dist` folder for viewing the live preview of the site in the development environment of the local machine HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from mattermost-developer-documentation.