diff --git a/docs/content-partner-guide.md b/docs/content-partner-guide.md index 3df71a1..9f73880 100644 --- a/docs/content-partner-guide.md +++ b/docs/content-partner-guide.md @@ -22,7 +22,7 @@ We work with several content partners who each work on their own timelines, inde Much of the publishing process is enabled through use of GitHub features. The diagram below provides a simple illustration of the overall process, and an explanation of each step follows. -![](images/devhub_publishing_process_simple.png) +![A diagram of the authoring and publishing process for DevHub. The process is described textually in the paragraph that follows the diagram.](images/devhub_publishing_process_simple.png) As a documentation writer, you edit or create files that will eventually be published in DevHub in your team's GitHub repository . When you want to preview your documentation, you can save your files to a preview branch (any branch other than a repo's default/main branch) in GitHub and after a few moments, it will then be available for review on the [preview instance of DevHub](https://dev.developer.gov.bc.ca). Once you're happy with your edits, you'll save your files into your repository's main branch. In this case, after a few moments, your latest documentation will be published and available on the [production DevHub instance](https://mvp.developer.gov.bc.ca). Each time you have changes or additions to make to your documentation, you iterate through this same process. @@ -54,7 +54,7 @@ The appearance of your content is determined by the Markdown syntax you include The images below provide an example of how a Markdown snippet in GitHub (first image) is displayed within DevHub (second image). -![](images/markdown_source.png) +![A screenshot of the Mardown source ](images/markdown_source.png) ![](images/devhub_appearance.png) diff --git a/mkdocs.yml b/mkdocs.yml index 48dce92..7cfff4c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -24,6 +24,7 @@ nav: - Get help in Rocket.Chat: rocketchat/get-help-in-rocketchat.md - Design System: - About the Design System: design-system/about-the-design-system.md + - DevHub Content Partner Guide: content-partner-guide.md # - Developer community: developer_community.md # - Application lifecycle: application_lifecycle.md # - Deploying applications: deploying_applications.md