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

Open
#1,383 1 comment 0 reactions 0 assignees View on GitHub

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 run command is executed in the local machine to see the development version.
  • The dist folder should be used ideally when the make run command is executed.
  • It needs to be investigated why the docs folder is being used instead of the dist 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

  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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.