Lightning talk how to edit the Silverstripe CMS docs
- 1. Lightning talk: How to edit the Silverstripe CMS docs Presented by – Michael Pritchard
- 2. Michael Pritchard 2 • First computer was a ZX Spectrum 48k • Twitter:@MikeAPritch Software developer
- 3. Agenda 3 • What is the problem? • How to edit one page?
- 4. What is the problem? 4 What we could do better Documentation is still a common thread in the responses about what we could do better. This is an open source project and we do encourage in particular the long-standing community members to share their knowledge by improving our docs. Rounding up the 2020 Community Survey https://www.silverstripe.org/blog/community- survey-results/
- 5. Requirements 5 • Markdown • GitHub account
- 6. How to edit a page 6
- 8. Preview 8
- 9. Fill in the Title DOC: … 9
- 11. CI will automatically run 11
- 13. Tip 13
Editor's Notes
- #3: I’ve been interested in software form a young age, when my uncle bought me a ZX Spectrum. I didn’t actually get into software development until much later, only 3 years ago, I installed a software package called REDCap and decided it would be good to learn how to write some code to access the APIs. I joined a public sector company (who I can’t name) in July 2021, just are the start of the Covid pandemic, so this is been an interesting year. So I’ve been a professional software developer for 1 year.
- #5: Silverstripe CMS documentation is a common thread in the responses on what we could do better
- #6: How anyone can edit the docs Knowledge of markdown – PhpStorm and VS Code have markdown editors either built in or as a downloadable plugin GitHub account
- #7: How anyone can edit the docs If you spot something which is not right on in the docs, they can be edited. Click the GitHub logo in the top right corner of the page When GitHub navigate to docs > en >Section > the document Click the pencil icon to edit the page in GitHub.
- #8: The markup is called Markdown, it is intended to be easy to read by humans, for the list of available syntax see: learn x in y minutes.com/docs/markdown/
- #9: Once the page has been edited, check the preview.
- #10: Scroll to the bottom, for the title needs to start DOC followed by a description of your change For more details you can fill in the optional extended description. Click propose changes. A pull request will be created and submitted to Silverstripe for approval
- #11: Create a pull request Then Create pull request once more
- #12: CI checks will automatically start. Note there are no conflicts with this base branch. Now you have to wait for the PR to be approved
- #13: For the full Silverstripe CMS documentation see https://docs.silverstripe.org/en/4/contributing/documentation/
- #14: If you have previously forked from the repository, then it's a good idea to click “fetch upstream” and “fetch and merge” before you make any further changes. If you do not do this you will have to squash your new brunch and resolve any conflicts.
- #15: Questions?