mattermost-developer-documentation
mattermost-developer-documentation copied to clipboard
`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
Related to another issue?
Yes, #1379 on Github in this repo.
Describe this issue
- A' docs' folder is created when the
make run
command is executed in the local machine to see the development version. - The
dist
folder should be used ideally when themake run
command is executed. - It needs to be investigated why the
docs
folder is being used instead of thedist
folder 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
docs
folder is being used instead of thedist
folder. As a preliminary investigation, theMakefile
can be a place to start. - Make the necessary changes in the
Makefile
file. - At the time of writing of this issue, it may have probably been included in the
.gitignore
file. If it is so, then perform the following steps: a) Removedocs
from.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.