Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update to use new date plugin #65

Merged
merged 35 commits into from
Dec 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
7445c02
Minor fixes (typos, etc.)
Nov 20, 2024
8e115ce
Updates with new content
Nov 20, 2024
2082aa5
More updates
Nov 20, 2024
133700a
Added details about AMBA, and governance best practices
Nov 25, 2024
62700e3
Added more content
Nov 26, 2024
c788b2d
Replaced 'Cloud Pathfinder' with 'Public Cloud'
Nov 26, 2024
9f715cd
Merge pull request #51 from bcgov/AE/azure-documentation-updates
wrnu Nov 26, 2024
276b8bc
Fixed broken page link
Dec 2, 2024
1aad426
Update docs/azure/best-practices/azure-ai.md
AErmie Dec 2, 2024
af509a0
Update docs/azure/best-practices/azure-ai.md
AErmie Dec 2, 2024
e8617c3
Update docs/azure/best-practices/azure-ai.md
AErmie Dec 2, 2024
36f1fa3
Update docs/azure/get-started-with-azure/bc-govs-azure-landing-zone-o…
AErmie Dec 2, 2024
878f60e
Update docs/azure/get-started-with-azure/bc-govs-azure-landing-zone-o…
AErmie Dec 2, 2024
569b9d5
Update docs/azure/design-build-deploy/user-management.md
AErmie Dec 2, 2024
dba672e
Update docs/azure/design-build-deploy/requirements.md
AErmie Dec 2, 2024
ac112e4
Update docs/azure/design-build-deploy/networking.md
AErmie Dec 2, 2024
7520f67
Update docs/azure/best-practices/azure-ai.md
AErmie Dec 2, 2024
8bb20ed
Update docs/azure/best-practices/azure-ai.md
AErmie Dec 2, 2024
9d09cf6
Merge branch 'main' into dev
Dec 2, 2024
179d3dc
Broken link fixes (#53)
AErmie Dec 2, 2024
80de8cb
Merge branch 'dev' of https://github.com/bcgov/public-cloud-techdocs …
Dec 2, 2024
62e1e88
Workflow updates (#55)
AErmie Dec 3, 2024
389bb63
Merge branch 'dev' of https://github.com/bcgov/public-cloud-techdocs …
Dec 3, 2024
18a774b
More link fixes (#54)
AErmie Dec 3, 2024
1f9c291
Merge branch 'dev' of https://github.com/bcgov/public-cloud-techdocs …
Dec 3, 2024
6e985f4
Workflow fixes (#56)
AErmie Dec 3, 2024
604c64f
Merge branch 'dev' of https://github.com/bcgov/public-cloud-techdocs …
Dec 3, 2024
466999a
Additional Link Fixes (#57)
AErmie Dec 3, 2024
04b011b
plugin for date and content management updates (#60)
Pilargit12 Dec 4, 2024
7426f65
Merging main into dev
Dec 4, 2024
b192840
updated local runtime instructions (#61)
MaxWardle Dec 6, 2024
02fb64f
Updated git ignore (#62)
AErmie Dec 6, 2024
faa4c3b
Updated all 'Last Updated' lines to use git-revision-date-localized p…
AErmie Dec 6, 2024
153d0ce
Fixed README PowerShell command (#64)
AErmie Dec 9, 2024
587c800
Updated markdown template file
Dec 9, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion .gitignore
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/
23 changes: 20 additions & 3 deletions README.md
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.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Deploy an application to the B.C. Government AWS Landing Zone

Last updated: **December 2, 2024**
Last updated: **{{ git_revision_date_localized }}**

The B.C. Government AWS Secure Environment Accelerator (ASEA) environment uses a multi-account architecture to provide secure and isolated environments for development, testing, production, and tools. This allows teams to safely build, test, and deploy applications without affecting live services.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# IAM User management service

Last updated: **December 2, 2024**
Last updated: **{{ git_revision_date_localized }}**

This solution employs AWS services such as DynamoDB, Lambda, and IAM for automated IAM user management and secure access key rotation. The necessary services are deployed into project sets within the ECF automation layers upon creation.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Networking within the AWS Secure Environment Accelerator (ASEA)

Last updated: **January 5, 2023**
Last updated: **{{ git_revision_date_localized }}**

## Introduction

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Requirements for building your application in AWS

Last updated: **December 2, 2024**
Last updated: **{{ git_revision_date_localized }}**

The following sections describe the requirements for building your application on the B.C. Government Public Cloud, AWS Landing Zone.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# AWS Sample applications

Last updated: **October 16, 2024**
Last updated: **{{ git_revision_date_localized }}**

We have several example applications to help you get started with building and deploying applications in the AWS Landing Zone.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# AWS Security and compliance guardrails

Last updated: **October 16, 2024**
Last updated: **{{ git_revision_date_localized }}**

As an AWS user, you must understand the restrictions and guidelines to ensure security and compliance. This document outlines the key points you need to know when using your AWS account.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# BC Gov's Product Registry - User management documentation

Last updated: **March 12, 2024**
Last updated: **{{ git_revision_date_localized }}**

Welcome to the BC Gov's Product Registry documentation. This guide provides detailed information about the new user interface changes and the enhanced user management feature available at [BC Gov's Product Registry](https://registry.developer.gov.bc.ca/). With the latest update, users can now manage AWS permissions directly from the website, enhancing the overall user experience and streamlining project management.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# B.C. Government OCIO AWS Landing Zone overview

Last updated: **February 5, 2024**
Last updated: **{{ git_revision_date_localized }}**

An overview of the B.C. Government OCIO's Landing Zone in AWS, how to get access, its benefits, components, and features.

Expand Down
2 changes: 2 additions & 0 deletions docs/aws/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Welcome to the Public Cloud AWS Technical Documentation

Last updated: **{{ git_revision_date_localized }}**

## Get started with AWS

Start here for the first steps on working in our AWS Secure Environment Accelerator (ASEA):
Expand Down
3 changes: 1 addition & 2 deletions docs/aws/support/enterprise-support.md
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.

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# AWS billing and cost management dashboards
Last updated: **August 26, 2024**

Last updated: **{{ git_revision_date_localized }}**

Learn more about managing your AWS spending and resources with our [AWS billing and cost management dashboard](https://loginproxy.gov.bc.ca/auth/realms/public-cloud/protocol/saml/clients/amazon-qs), featuring the Cloud Intelligence Dashboards and CUDOS (AWS Cost and Usage Dashboards Operations Solution).

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Calgary region in AWS Secure Environment Accelerator (SEA)

Last updated: **August 25, 2024**
Last updated: **{{ git_revision_date_localized }}**

## Overview

Expand Down
2 changes: 1 addition & 1 deletion docs/azure/best-practices/azure-ai.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Azure AI services

Last updated: **December 2, 2024**
Last updated: **{{ git_revision_date_localized }}**

Many of the ministry teams are using Azure AI services to build intelligent applications. Artificial Intelligence and Machine Learning are rapidly changing technologies. The following are some recommendations and guidance based on observations and experiences from the ministry teams.

Expand Down
2 changes: 1 addition & 1 deletion docs/azure/best-practices/be-mindful.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Be mindful

Last updated: **November 20, 2024**
Last updated: **{{ git_revision_date_localized }}**

The following are some things to be aware of when working within the Azure Landing Zone.

Expand Down
2 changes: 1 addition & 1 deletion docs/azure/best-practices/ci-cd.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# CI/CD Best practices

Last updated: **November 20, 2024**
Last updated: **{{ git_revision_date_localized }}**

## GitHub Actions

Expand Down
2 changes: 1 addition & 1 deletion docs/azure/best-practices/governance.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Governance

Last updated: **November 26, 2024**
Last updated: **{{ git_revision_date_localized }}**

The following describes how to manage and govern your Azure environment. While the Public Cloud team provides the initial guardrails and standards for the environment, **each ministry team is responsible** for managing their own resources and ensuring compliance with the standards.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Deploy to the Azure Landing Zone

Last updated: **November 20, 2024**
Last updated: **{{ git_revision_date_localized }}**

There are multiple ways to deploy your application to the Azure Landing Zone. This document outlines a few examples at a high-level, but it is up to each team to determine the best approach for their application.

Expand Down
2 changes: 1 addition & 1 deletion docs/azure/design-build-deploy/networking.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Networking within the Azure Landing Zone

Last updated: **December 4, 2024**
Last updated: **{{ git_revision_date_localized }}**

Within each Project Set deployed in the Azure Landing Zone, a [Virtual Network (VNet)](https://learn.microsoft.com/en-us/azure/virtual-network/virtual-networks-overview) is created to provide network isolation and security for the resources deployed within it. This VNet is the foundation for all network connectivity within the Azure Landing Zone.

Expand Down
2 changes: 1 addition & 1 deletion docs/azure/design-build-deploy/requirements.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Requirements for building your application in Azure

Last updated: **December 2, 2024**
Last updated: **{{ git_revision_date_localized }}**

The following sections describe the requirements for building your application on the B.C. Government Public Cloud Azure Landing Zone.

Expand Down
2 changes: 1 addition & 1 deletion docs/azure/design-build-deploy/sample-apps.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Azure Sample Applications

Last updated: **October 8, 2024**
Last updated: **{{ git_revision_date_localized }}**

We have several example applications to help you get started with building and deploying applications in the Azure Landing Zone.

Expand Down
2 changes: 1 addition & 1 deletion docs/azure/design-build-deploy/user-management.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# User management in the Azure Landing Zone

Last updated: **December 4, 2024**
Last updated: **{{ git_revision_date_localized }}**

This guide provides an overview of user management in the Azure Landing Zone, specifically tailored for Product Owners (POs) and Technical Leads (TLs) who have been granted a restricted Owner role on the Project Set Management Group. This role is inherited on the subscription within the Project Set.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# B.C. Government OCIO Azure Landing Zone overview

Last updated: **December 4, 2024**
Last updated: **{{ git_revision_date_localized }}**

An overview of the B.C. Government OCIO's Landing Zone in Azure, how to get access, its benefits, components, and features.

Expand Down
2 changes: 2 additions & 0 deletions docs/azure/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Welcome to the Public Cloud Azure Technical Documentation

Last updated: **{{ git_revision_date_localized }}**

## Get started with Azure

Start here for the first steps on working in our Azure Landing Zone (ALZ):
Expand Down
2 changes: 1 addition & 1 deletion docs/azure/support/enterprise-support.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Microsoft Azure Enterprise Support

Last updated: **December 2, 2024**
Last updated: **{{ git_revision_date_localized }}**

Once your Project Set has been provisioned, each Azure Subscription will be enrolled in the Azure Unified Support plan. There is a delay of approximately **2 weeks** for the Azure Unified Support plan to be activated.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Azure billing and cost management

Last updated: **December 2, 2024**
Last updated: **{{ git_revision_date_localized }}**

## Cost Reporting and Cost Recovery

Expand Down
2 changes: 1 addition & 1 deletion docs/azure/upcoming-features/domain-join.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# DNS for Domain Join

Last updated: **October 3, 2024**
Last updated: **{{ git_revision_date_localized }}**

## Overview

Expand Down
2 changes: 1 addition & 1 deletion docs/azure/upcoming-features/express-route.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Express Route Connectivity to On-Premises

Last updated: **November 20, 2024**
Last updated: **{{ git_revision_date_localized }}**

## Overview

Expand Down
2 changes: 2 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Welcome to the Public Cloud Technical Documentation

Last updated: **{{ git_revision_date_localized }}**

## Overview

This documentation provides information for using Public Cloud services within the B.C. Government. It covers both [Amazon Web Services (AWS)](#amazon-web-services-aws) and [Microsoft Azure](#microsoft-azure) platforms, offering resources for [provisioning project sets](#provision-a-project-set), and for designing, building, and deploying applications in these environments. Whether you're new to cloud computing or an experienced developer, you'll find valuable information to help you navigate the B.C. Government's public cloud infrastructure.
Expand Down
2 changes: 1 addition & 1 deletion docs/welcome/provision-a-project-set.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Provision a new Project Set

Last updated: **December 2, 2024**
Last updated: **{{ git_revision_date_localized }}**

On the Public Cloud platform, different teams organize their work in isolated **Project Sets**. Before working in the cloud platform, the **Product Owner** of the respective team must submit a Project Set provisioning request for your team, through the [BC Platform Services Product Registry](https://registry.developer.gov.bc.ca/login).

Expand Down
2 changes: 1 addition & 1 deletion docs/welcome/support.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Public Cloud Support

Last updated: **November 26, 2024**
Last updated: **{{ git_revision_date_localized }}**

## Support options

Expand Down
2 changes: 1 addition & 1 deletion docs/welcome/training.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Public Cloud Training

Last updated: **December 2, 2024**
Last updated: **{{ git_revision_date_localized }}**

## AWS

Expand Down
2 changes: 1 addition & 1 deletion docs/welcome/why-use-public-cloud.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Why use the B.C. Government Landing Zones in Public Cloud?

Last updated: **October 3, 2024**
Last updated: **{{ git_revision_date_localized }}**

## Benefits of building apps in the Public Cloud

Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,4 @@ nav:
- Azure Enterprise Support: azure/support/enterprise-support.md
plugins:
- techdocs-core
- git-revision-date-localized
22 changes: 10 additions & 12 deletions new-markdown-document-template.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,36 @@
# Page title in sentence case
Last updated: **Month day, year**

AErmie marked this conversation as resolved.
Show resolved Hide resolved
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)


Loading