mattermost / mattermost/mattermost-developer-documentation
`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
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 90
- Forks
- 460
- Avg merge
- 9d 23h
- Merged PRs (30d)
- 2
Description
Related to another issue?
Yes, #1379 on Github in this repo.
Describe this issue
- A' docs' folder is created when the
make runcommand is executed in the local machine to see the development version. - The
distfolder should be used ideally when themake runcommand is executed. - It needs to be investigated why the
docsfolder is being used instead of thedistfolder when generating a live preview of the site.
Observed behavior
When the make run command is executed, the live preview site is in the docs folder.
Expected behavior
When the make run command is executed, the live preview site should be present in the dist folder instead.
Proposed solution
Solution #1
- Investigate why the
docsfolder is being used instead of thedistfolder. As a preliminary investigation, theMakefilecan be a place to start. - Make the necessary changes in the
Makefilefile. - At the time of writing of this issue, it may have probably been included in the
.gitignorefile. If it is so, then perform the following steps:
a) Removedocsfrom.gitignore.
b) Also remove the associated comment in.gitignore.
Solution #2
According to this highlighted comment:
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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Makefile and config.toml to trace how make run selects the preview output, then inspect .gitignore for the docs entry and its associated comment. The work is done when the live preview is generated in dist instead of docs, with the relevant ignore configuration updated if needed.
Written by the indexing model from the issue text.
Assessment
- Domain
- build-system, documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100