Skip to content

Commit

Permalink
update dev docs
Browse files Browse the repository at this point in the history
- I verified all navigation links work as expected.
- I added place holder index.md files for sections missing them.
- I updated a few references from daaas to AAW but there remains a few
- For some reason make install downloads a bunch of readme files from various repos.
  • Loading branch information
Bryan Paget committed Jun 26, 2023
1 parent caddb6f commit ed1009b
Show file tree
Hide file tree
Showing 17 changed files with 40 additions and 40 deletions.
11 changes: 0 additions & 11 deletions .spelling
Original file line number Diff line number Diff line change
Expand Up @@ -295,18 +295,12 @@ arcgis
arcgis
onboarding
saml
daaas
daaas
daaas
daaas
gis
arcgis
submodule
create_buffers
daaas
arcgis
dataframes
daaas
matplotlib
centered
basemap
Expand Down Expand Up @@ -365,14 +359,9 @@ arcgis
arcgis
arcgis
l'id
daaas
daaas
daaas
daaas
qu'arcgis
arcgis.features
use_proximity
daaas
geo
d'arcgis
update
Expand Down
3 changes: 3 additions & 0 deletions docs/dev/developer-tools.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Developer Tools

Under construction.
3 changes: 3 additions & 0 deletions docs/dev/features/data-virtualization/trino.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Trino

Under Construction.
3 changes: 3 additions & 0 deletions docs/dev/features/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# AAW Features

Under Construction.
File renamed without changes
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@ Welcome to the team! :)
| | <https://www.youtube.com/watch?v=4ht22ReBjno&ab_channel=Deis%2CInc.> |
| | <https://www.youtube.com/watch?v=PziYflu8cB8&ab_channel=Fireship> |

You can use the interactive learning on
[KataCoda](https://www.katacoda.com/statcan), but not completing or
understanding everything is alright as long as you have some idea.
You can use the interactive learning on [KataCoda](https://www.katacoda.com/statcan), but not completing or understanding everything is alright as long as you have some idea.

## Good Starter GitHub Repos to Explore

Expand All @@ -27,30 +25,28 @@ understanding everything is alright as long as you have some idea.

<!-- prettier-ignore -->
!!! Attention
Everything below will require your work laptop; if you don't have your work laptop yet, keep training
Everything below will require your work laptop; if you don't have your work laptop yet, keep training.

## Setup

[If you have just recieved your laptop](setup.md)
[If you have just received your laptop](setup.md)

## At this point

- [ ] Your Cloud Account login details should have been sent to our
firstname.lastname@canada email
- [ ] You should have a GitHub account
- [ ] Subscriptions should have been added to your Azure account
- [ ] All the Teams meeting links should have been forwarded to you
- [ ] You should be part of the Slack!
- [ ] You should be part of the Discord Servers
- [x] Your Cloud Account login details should have been sent to your `firstname.lastname@statcan.gc.ca` email address.
- [x] You should have a GitHub account.
- [x] Subscriptions should have been added to your Azure account.
- [x] All the Teams meeting links should have been forwarded to you.
- [x] You should be part of the Slack!
- [x] You should be part of the Discord Servers!

<!-- prettier-ignore -->
!!! Missing
If you are missing any of the above, let your supervisor know
If you are missing any of the above, let your supervisor know.

## TMS

You will need to log your hours worked into the Time Management System; you can
do it every day or even just every Friday. **Make sure to log your hours.**
You will need to log your hours worked into the Time Management System; you can do it every day or even just every Friday. **Make sure to log your hours.**

> [Logging your Hours.](tms.md)
Expand All @@ -65,8 +61,8 @@ do it every day or even just every Friday. **Make sure to log your hours.**
## Running into Issues

If you happen to run into any problems, ask your supervisor or co-workers for
help.
<strong>Consider consulting the diagram below.</strong>
help. <strong>Consider consulting the diagram below.</strong>

![Placeholder](images/diagram.png)

## Helpful Resources
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
3 changes: 3 additions & 0 deletions docs/dev/resources/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Resources

Under Construction.
23 changes: 13 additions & 10 deletions mkdocs-dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,21 +28,24 @@ theme:
accent: blue
nav:
- Features:
- Get Started: dev/getting-started/index.md
- Overview: dev/features/index.md
- Getting Started: getting-started/index.md
- Overview: features/index.md
- Object Storage:
- S3Proxy and S3 Explorer: dev/features/object-storage/s3proxy.md
- Blob CSI: dev/features/object-storage/blobcsi.md
- Cloud Main Connectivity: dev/features/cloud-main-connectivity/cloud-main-connectivity.md
- Data Virtualization: dev/features/data-virtualization/trino.md
- S3Proxy and S3 Explorer: features/object-storage/s3proxy.md
- Blob CSI: features/object-storage/blobcsi.md
- Cloud Main Connectivity: features/cloud-main-connectivity/cloud-main-connectivity.md
- Data Virtualization: features/data-virtualization/trino.md
- RBAC:
- Non-Employee RBAC: dev/features/rbac/non-employee-rbac.md
- Source Control: dev/features/source-control/gitea.md
- Non-Employee RBAC: features/rbac/non-employee-rbac.md
- Source Control: features/source-control/gitea.md
- Resources:
- Overview: dev/resources/index.md
- Developer Tools: dev/developer-tools.md
- Overview: resources/index.md
- Developer Tools: developer-tools.md

markdown_extensions:
- def_list
- pymdownx.tasklist:
custom_checkbox: true
- toc:
baselevel: 1
permalink: true
Expand Down
2 changes: 1 addition & 1 deletion mkdocs-en.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ strict: true
docs_dir: docs/en
site_dir: site/en

repo_name: StatCan/daaas
repo_name: StatCan/aaw
repo_url: https://github.com/StatCan/aaw
edit_uri: edit/master/docs/en

Expand Down
2 changes: 1 addition & 1 deletion mkdocs-fr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ copyright: Copyright &copy; 2023 Statistics Canada
docs_dir: docs/fr
site_dir: site/fr

repo_name: StatCan/daaas
repo_name: StatCan/aaw
repo_url: https://github.com/StatCan/aaw
edit_uri: edit/master/docs/fr

Expand Down

0 comments on commit ed1009b

Please sign in to comment.