bcgov / bcgov/cloud-pathfinder

Create "Examples and Best Practices" page for Tech Docs website

Open
#2,666 0 comments 0 reactions 0 assignees View on GitHub
Documentation Technology
Dominant language
Jinja
Stars
2
Forks
7
PR merge metrics
No merged PRs in 30d

Description

Create a page outlining examples and best practices to follow in AWS. Check the existing content in Pre-reading material and in the docs that Carles put together.

Acceptance criteria:
- [ ] create a draft page on Google Drive for Examples and Best Practices (re-use the existing content as much as possible but try to shorten/simplify if possible)
- [ ] sign off by Warren and Max
- [ ] hand over to Pilar to finalizing

_Context: Selected as a top 10 article for technical documentation:
https://app.zenhub.com/workspaces/cloud-pathfinder-5e4dbb426c3c6af8dcbf06a7/issues/gh/bcgov/cloud-pathfinder/2590_

Contributor guide

No contributing guide indexed for this repository

Research direction

Review the existing Pre-reading material and the documentation Carles put together, then draft the Examples and Best Practices page in Google Drive using and simplifying that content. Completion requires Warren and Max to sign off and the draft to be handed over to Pilar for finalization.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws
Domain
cloud, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.