mattermost / mattermost-developer-documentation

Mattermost developer documentation.
https://developers.mattermost.com
BSD 3-Clause "New" or "Revised" License
79 stars 383 forks source link

`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 #1383

Open chessmadridista opened 1 month ago

chessmadridista commented 1 month ago

Related to another issue?

Yes, #1379 on Github in this repo.


Describe this issue


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

  1. Investigate why the docs folder is being used instead of the dist folder. As a preliminary investigation, the Makefile can be a place to start.
  2. Make the necessary changes in the Makefile file.
  3. 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) Remove docs 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.

chessmadridista commented 1 month ago

I would be happy to take up this issue.