Write a tutorial about how to work on the site locally
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 136
- Forks
- 555
- Avg merge
- 4d 14h
- Merged PRs (30d)
- 4
Description
Write a tutorial about how to work on the site locally #1103
Information on how to run the site locally should be updated here
This is tricky because it involves using submodules.
@eternoendless does this: cloning devdocs-site, then working on the submodule directory and then push to own docs remote
Items completed
- The docs is about how to contribute. Reference information on how the devdocs is deployed should go to the README in https://github.com/PrestaShop/devdocs-site/
=> pull requests
- Branch information should be added as a "Documentation versions" subsection here. I think it would be best to add it at the top, before "Edit on Github".
=> pull request:
Contributor guide
No contributing guide indexed for this repository
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 existing documentation page at contribute/documentation/how/edit-on-your-computer/ and review the related README in devdocs-site. Check pull requests #1, #1104, and #1106 to see which requested updates are already covered. Done means the local-work tutorial, including submodule handling, and the Documentation versions subsection are accurately represented in the documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git, github
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 15/100