-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Minor fixes (typos, etc.) * Updates with new content * More updates * Added details about AMBA, and governance best practices * Added more content * Replaced 'Cloud Pathfinder' with 'Public Cloud' * Fixed broken page link * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/get-started-with-azure/bc-govs-azure-landing-zone-overview.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/get-started-with-azure/bc-govs-azure-landing-zone-overview.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/design-build-deploy/user-management.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/design-build-deploy/requirements.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/design-build-deploy/networking.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Broken link fixes (#53) * Fix "owner" value so links to team page work properly in DevHub Fix "owner" value so links to team page work properly in DevHub. Currently, the link to team owning the docs is broken in Devhub. This change will fix so it displays.a team details page when clicked. * TechDocs Updates for Azure Contnet (#52) * Minor fixes (typos, etc.) * Updates with new content * More updates * Added details about AMBA, and governance best practices * Added more content * Replaced 'Cloud Pathfinder' with 'Public Cloud' * Fixed broken page link * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/get-started-with-azure/bc-govs-azure-landing-zone-overview.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/get-started-with-azure/bc-govs-azure-landing-zone-overview.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/design-build-deploy/user-management.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/design-build-deploy/requirements.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/design-build-deploy/networking.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> --------- Co-authored-by: Adin Ermie <[email protected]> Co-authored-by: Warren Uniewski <[email protected]> Co-authored-by: Pilar Solares <[email protected]> * Fixed broken links * Update docs/aws/design-build-and-deploy-an-application/requirements-for-building-your-application.md Co-authored-by: Copilot <[email protected]> --------- Co-authored-by: Shea Phillips <[email protected]> Co-authored-by: Abibat Adesina <[email protected]> Co-authored-by: Warren Uniewski <[email protected]> Co-authored-by: Adin Ermie <[email protected]> Co-authored-by: Pilar Solares <[email protected]> Co-authored-by: Copilot <[email protected]> * Workflow updates (#55) * Fix "owner" value so links to team page work properly in DevHub Fix "owner" value so links to team page work properly in DevHub. Currently, the link to team owning the docs is broken in Devhub. This change will fix so it displays.a team details page when clicked. * TechDocs Updates for Azure Contnet (#52) * Minor fixes (typos, etc.) * Updates with new content * More updates * Added details about AMBA, and governance best practices * Added more content * Replaced 'Cloud Pathfinder' with 'Public Cloud' * Fixed broken page link * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/get-started-with-azure/bc-govs-azure-landing-zone-overview.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/get-started-with-azure/bc-govs-azure-landing-zone-overview.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/design-build-deploy/user-management.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/design-build-deploy/requirements.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/design-build-deploy/networking.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> --------- Co-authored-by: Adin Ermie <[email protected]> Co-authored-by: Warren Uniewski <[email protected]> Co-authored-by: Pilar Solares <[email protected]> * Added PR workflow * YAML syntax fix * Added CODEOWNERS file * Update .github/CODEOWNERS --------- Co-authored-by: Shea Phillips <[email protected]> Co-authored-by: Abibat Adesina <[email protected]> Co-authored-by: Warren Uniewski <[email protected]> Co-authored-by: Adin Ermie <[email protected]> Co-authored-by: Pilar Solares <[email protected]> * More link fixes (#54) * Fix "owner" value so links to team page work properly in DevHub Fix "owner" value so links to team page work properly in DevHub. Currently, the link to team owning the docs is broken in Devhub. This change will fix so it displays.a team details page when clicked. * TechDocs Updates for Azure Contnet (#52) * Minor fixes (typos, etc.) * Updates with new content * More updates * Added details about AMBA, and governance best practices * Added more content * Replaced 'Cloud Pathfinder' with 'Public Cloud' * Fixed broken page link * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/get-started-with-azure/bc-govs-azure-landing-zone-overview.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/get-started-with-azure/bc-govs-azure-landing-zone-overview.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/design-build-deploy/user-management.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/design-build-deploy/requirements.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/design-build-deploy/networking.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> --------- Co-authored-by: Adin Ermie <[email protected]> Co-authored-by: Warren Uniewski <[email protected]> Co-authored-by: Pilar Solares <[email protected]> * More broken link fixes --------- Co-authored-by: Shea Phillips <[email protected]> Co-authored-by: Abibat Adesina <[email protected]> Co-authored-by: Warren Uniewski <[email protected]> Co-authored-by: Adin Ermie <[email protected]> Co-authored-by: Pilar Solares <[email protected]> * Workflow fixes (#56) * Fix "owner" value so links to team page work properly in DevHub Fix "owner" value so links to team page work properly in DevHub. Currently, the link to team owning the docs is broken in Devhub. This change will fix so it displays.a team details page when clicked. * TechDocs Updates for Azure Contnet (#52) * Minor fixes (typos, etc.) * Updates with new content * More updates * Added details about AMBA, and governance best practices * Added more content * Replaced 'Cloud Pathfinder' with 'Public Cloud' * Fixed broken page link * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/get-started-with-azure/bc-govs-azure-landing-zone-overview.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/get-started-with-azure/bc-govs-azure-landing-zone-overview.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/design-build-deploy/user-management.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/design-build-deploy/requirements.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/design-build-deploy/networking.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> --------- Co-authored-by: Adin Ermie <[email protected]> Co-authored-by: Warren Uniewski <[email protected]> Co-authored-by: Pilar Solares <[email protected]> * Workflow fixes * Added workflow_dispatch --------- Co-authored-by: Shea Phillips <[email protected]> Co-authored-by: Abibat Adesina <[email protected]> Co-authored-by: Warren Uniewski <[email protected]> Co-authored-by: Adin Ermie <[email protected]> Co-authored-by: Pilar Solares <[email protected]> * Additional Link Fixes (#57) * Fix "owner" value so links to team page work properly in DevHub Fix "owner" value so links to team page work properly in DevHub. Currently, the link to team owning the docs is broken in Devhub. This change will fix so it displays.a team details page when clicked. * TechDocs Updates for Azure Contnet (#52) * Minor fixes (typos, etc.) * Updates with new content * More updates * Added details about AMBA, and governance best practices * Added more content * Replaced 'Cloud Pathfinder' with 'Public Cloud' * Fixed broken page link * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/get-started-with-azure/bc-govs-azure-landing-zone-overview.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/get-started-with-azure/bc-govs-azure-landing-zone-overview.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/design-build-deploy/user-management.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/design-build-deploy/requirements.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/design-build-deploy/networking.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> --------- Co-authored-by: Adin Ermie <[email protected]> Co-authored-by: Warren Uniewski <[email protected]> Co-authored-by: Pilar Solares <[email protected]> * Trigger Build * Removed filter for PRs, added link path oddity * Fixed other broken link path * Updated workflow names * Updated README with local prereqs --------- Co-authored-by: Shea Phillips <[email protected]> Co-authored-by: Abibat Adesina <[email protected]> Co-authored-by: Warren Uniewski <[email protected]> Co-authored-by: Adin Ermie <[email protected]> Co-authored-by: Pilar Solares <[email protected]> * plugin for date and content management updates (#60) * updated local runtime instructions (#61) * Updated git ignore (#62) Co-authored-by: Adin Ermie <[email protected]> * Updated all 'Last Updated' lines to use git-revision-date-localized plugin to auto-populate date (#63) Co-authored-by: Adin Ermie <[email protected]> * Fixed README PowerShell command (#64) Co-authored-by: Adin Ermie <[email protected]> * Updated markdown template file --------- Co-authored-by: Adin Ermie <[email protected]> Co-authored-by: Warren Uniewski <[email protected]> Co-authored-by: Pilar Solares <[email protected]> Co-authored-by: Shea Phillips <[email protected]> Co-authored-by: Abibat Adesina <[email protected]> Co-authored-by: Copilot <[email protected]> Co-authored-by: Max Wardle <[email protected]>
- Loading branch information
1 parent
06bd4ce
commit 5ead3a0
Showing
36 changed files
with
73 additions
and
46 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,7 @@ | ||
.DS_Store | ||
.DS_Store | ||
|
||
# generated stuff from local run | ||
patcher.py | ||
test_patcher.py | ||
site/ | ||
tmp/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,35 @@ | ||
# Public Cloud technical documentation | ||
This is a single location for all technical/developer documentation for product teams working on the Public Cloud Platform. | ||
|
||
Visit the deployed Gatsby site at [docs.developer.gov.bc.ca](https://docs.developer.gov.bc.ca/). See how that's deployed at the [private-cloud-techdocs](https://github.com/bcgov/private-cloud-techdocs) repo. | ||
Visit the deployed Gatsby site at [docs.developer.gov.bc.ca](https://developer.gov.bc.ca/). See how that's deployed at the [private-cloud-techdocs](https://github.com/bcgov/platform-developer-docs/tree/07904f54dc36c33db156145945be6c00b62483d2) repo. | ||
|
||
# Documentation | ||
Markdown documents are located in `./docs` with related images in `./images`. | ||
|
||
In progress (not yet published) documents are located in `./drafts`. | ||
|
||
Please see [Writing guide for Platform Services technical documentation](https://github.com/bcgov/private-cloud-techdocs/blob/main/tech-docs-writing-guide.md) for documentation formatting and contribution information. | ||
Please see [Writing guide for Platform Services technical documentation](https://github.com/bcgov/platform-developer-docs/blob/07904f54dc36c33db156145945be6c00b62483d2/tech-docs-writing-guide.md) for documentation formatting and contribution information. | ||
|
||
Start your new document from the new [Markdown document template](/new-markdown-document-template.md). | ||
|
||
# Deploy locally | ||
To deploy locally you need to have Node.js installed. If you don't have it installed, you can download it from [here](https://nodejs.org/en/download/). You will also need to have Docker installed. If you don't have it installed, you can download it from [here](https://www.docker.com/products/docker-desktop). | ||
|
||
After you have Node.js and Docker installed, you can run the following commands to deploy the documentation locally: `npx @techdocs/cli serve`. A browser should open with an un-themed, but formatted version of the documentation. This closely resembles what will be visible on the end product. | ||
After you have Node.js and Docker installed, you can follow these instructions to [preview content locally](https://github.com/bcgov/devhub-techdocs-publish/blob/main/docs/index.md#how-to-use-the-docker-image-to-preview-content-locally). A browser should open with an un-themed, but formatted version of the documentation. This closely resembles what will be visible on the end product. | ||
|
||
## Windows Users | ||
If you are using Windows, the command provided in the instructions will not work. You have 2 options, either execute a modified command (listed below) from a PowerShell terminal, or execute the command from a Windows Subsystem for Linux (WSL) terminal. | ||
|
||
> NOTE: The site will not auto-launch in your browser. You will need to click on the link provided in the terminal output (ie. http://localhost:3000). | ||
**PowerShell Terminal Command:** | ||
```powershell | ||
docker run -it -p 3000:3000 -v ${PWD}:/github/workspace ghcr.io/bcgov/devhub-techdocs-publish preview | ||
``` | ||
|
||
**WSL Terminal Command:** | ||
```wls | ||
docker run -it -p 3000:3000 $(pwd):/github/workspace ghcr.io/bcgov/devhub-techdocs-publish preview | ||
``` | ||
|
||
> NOTE: If you are executing the command from a WSL terminal, you will need to have the repository cloned into your WSL environment. |
2 changes: 1 addition & 1 deletion
2
...design-build-and-deploy-an-application/deploy-an-app-to-the-aws-landing-zone.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
docs/aws/design-build-and-deploy-an-application/iam-user-service.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...n-build-and-deploy-an-application/requirements-for-building-your-application.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
docs/aws/design-build-and-deploy-an-application/security-guardrails.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
docs/aws/design-build-and-deploy-an-application/user-management.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
docs/aws/get-started-with-aws/bc-govs-aws-landing-zone-overview.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,5 @@ | ||
# AWS Enterprise Support | ||
|
||
Last updated: **October 8, 2024** | ||
Last updated: **{{ git_revision_date_localized }}** | ||
|
||
Once your Project Set has been provisioned, the AWS Account will be enrolled in the AWS Enterprise Support. Only the Production AWS Account will be enrolled in the AWS Enterprise Support. | ||
|
2 changes: 1 addition & 1 deletion
2
...nding-your-aws-bill/aws-billing-and-cost-management-dashboard-via-quicksight.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
docs/aws/upcoming-features/calgary-region-in-aws-secure-environment-accelerator.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
docs/azure/design-build-deploy/deploy-to-the-azure-landing-zone.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
docs/azure/get-started-with-azure/bc-govs-azure-landing-zone-overview.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
docs/azure/understanding-your-bill/azure-billing-and-cost-management.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,38 +1,36 @@ | ||
# Page title in sentence case | ||
Last updated: **Month day, year** | ||
|
||
This space is used to describe what your page will be about and who it will help. It is a great way to introduce the subject that you will develop throughout the page | ||
Last updated: **{{ git_revision_date_localized }}** | ||
|
||
--- | ||
This space is used to describe what your page will be about and who it will help. It is a great way to introduce the subject that you will develop throughout the page. | ||
|
||
<!-- Notice the --- separation to beging the next #H2 heading after H1 and description --> | ||
--- | ||
|
||
<!-- Notice the --- separation to begin the next #H2 heading after H1 and description --> | ||
|
||
## First H2 content heading in sentence case | ||
|
||
This is paragraph text that appears under the first heading. | ||
|
||
### H3 content heading | ||
### H3 content heading | ||
|
||
Supplements H2 heading information but does not propose new content outside of this topic | ||
|
||
#### H4 content heading | ||
#### H4 content heading | ||
|
||
Only add if really necessary and again complements your H3 heading | ||
|
||
##### Avoid H5 headings and below | ||
##### Avoid H5 headings and below | ||
|
||
## Second H2 content heading | ||
## Second H2 content heading example | ||
|
||
This is paragraph text that appears under the second heading. | ||
|
||
|
||
--- | ||
|
||
<!-- Notice again --- separator to present related pages next --> | ||
## Related pages | ||
|
||
Links that supplement the document or that go as further next steps into the topic | ||
Links that supplement the document or that go as further next steps into the topic | ||
|
||
- [Example.org](https://example.org) | ||
|
||
|