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

Public Reference Architecture Release #646

Merged
merged 27 commits into from
Aug 9, 2024
Merged

Public Reference Architecture Release #646

merged 27 commits into from
Aug 9, 2024

Conversation

milldr
Copy link
Member

@milldr milldr commented Aug 9, 2024

what

  • Redesigne the entire documentation site
  • Updated the release workflows

why

We are making all documentation public! As such we migratated all of our documentation to cloudposse/docs and reorganize many documentation pages, to improve the learning journey.

references

DEV-2295

milldr and others added 26 commits June 9, 2024 09:33
* Add workflow for deploying staging website previews

* Update IAM role ARN in workflow file

* Add GitHub Actions for deploying and destroying staging

* Update deployment workflow to include 'main' branch

* Update deployment host URL in staging preview workflow

* Update deployment host in staging workflows

* created staging release pipelines

* Add build website action for staging release workflow

* Add build-staging target to Makefile

* Update inputs reference, remove secrets in workflow files

* Update action.yml script for rendering documentation

* Update required fields and default values in action.yml

* Update deploy job names and workflow names for staging

* Update workflow name and job name for clarity

* Update staging workflow names for clarity

* Add initial Docusaurus configuration

* Update build-staging to install production dependencies

* major refactor of docs v2

* Update sidebar settings for Network and DNS layer

* Delete staging.css file

* Update pull request event trigger to 'pull_request' type

* refarch assets

* major refactor of docs v2

* major refactor of docs v2
* Rename files, add new foundational decisions page

* refactored learning path and organized all design decisions

* refactored learning path and organized all design decisions

* Rename legacy-docs/10-addons.md to docs/layers/bonus-tutorials/10-addons.md
* clean up the foundation layer

* clean up the foundation layer

* clean up the foundation layer

* clean up the foundation layer

* clean up the foundation layer

* revert refarch-id, fix admoinitions

* prettier

* fixed more admonitions

* DEV-2382: Manage Accounts Clean Up (#618)

* cleaning account chapter

* cleaning account chapter

* pty

* Update account designations and recommendations

* Add caution about cross-account AWS support limitations

* DEV-2383: Refactor Identity Chapter (#619)

* refactored identity chapter

* refactored identity chapter

* refactored identity chapter

* refactored identity chapter

* DEV-2384: Refactor Learn Network and DNS (#620)

* refactored network chapter

* refactored network chapter

* refactored network chapter

* refactored network chapter

* DEV-2385: Refactor Container Orchestration (#621)

* Refactor ecs

* refactor eks

* refactor eks

* refactor eks

* removed all custom_edit_url

* updated sidebar titles

* refarch-sync feedback
* Upgrade to docusarus 3.4.0

* adjust the nav bar

* fix build

* fix mdx

* Add components

* finish upgrade to 3.4

* bump node version

* add placeholders

* add placeholders

* fix deprecated actions

* upgrade actions

* upgrade modules
* customize css to match atmos.tools

* style landing page
* reorg community

* fix atmos refs
* formatting

* rename for consistency. update titles.

* update titles and sidebar lables. swizzle doccard components
* add intros

* add more intro and copies

* add CTAs, office hours videos and format design decisions

* reorg sidebar into smaller sections

* reorg tutorials, format design decision indexes

* format steps

* add step numbers

* formatting

* formatting

* format component development

* move legacy design decisions, more formatting

* format pages

* reorg adrs

* wip

* add missing tutorial indexes

* reformat tables

* minor formatting

* minor formatting

* bump versions

* fix copy, disable modules and actions generation

* fix index pages and copy

* fix category pages

* fix build

* add missing index

* rebuild package-lock.json

* try to fix build
* import gitops

* New TagList component

* fix keyboard shortcuts when other key combinations are pressed, broken links, index pages, etc

* disable console.log

* remove image sizes which are frequently wrong due to bad export from confluence

* add missing file, update nav

* disable console log

* debug failures

* debug failures

* debug failures

* debug failures

* content updates

* content updates

* import spacelift docs
* fix broken links

* fix broken links

* fix broken links
* adjust titles

* Update module readme MD file with fixed URLs and content

* Update custom loaders resolved path and add method to fetch Terraform files

* Refactor terraform file fetching method for efficiency

* Fix MDX format and <details><summary> html tags

* Fix URL formatting in MDX content rendering

* Disable category.json rendering and clean up URLs

* Update Terraform docs rendering and collapse sidebar items

* Update anchor tags for inputs and outputs in Terraform docs

* Cache tmp directory and update sidebar label

* Cache rendered content for website build process

* Add logging for module provider and name, and docs directory

* Render terraform docs and README for module directory

* Update debug logging and exclude terraform-aws-components

* Add debug logging for ls commands in ModuleRenderer

* Refactor debug logging in ModuleRenderer.py

* Refactor build target in Makefile and logging in Python script

* Replace <= with &lt;= to avoid parsing issues

* Update GitHub Action edit URL and fix MDX formatting

* Update mdx formatting in rendering.py

* Update sidebar directory path for GitHub actions

* Update sidebar_label to 'actions' and add sidebar_class_name

* Remove cache files from .gitignore

* Update cache handling logic for GitHubProvider
* Update Terraform documentation formatting

* Update cache key for restoring cache in all jobs

* merge frontmatter tags

* added all chatgpt generated tags

* Add layers, providers, and components metadata

* added all chatgpt generated tags

* Update variables and dependencies in Terraform documentation

* Add PyYAML 6.0.1 to requirements.txt

* Add function to get Terraform version from module

* Update function call to use local function for Terraform version

* Apply suggestions from code review

Co-authored-by: Erik Osterman (CEO @ Cloud Posse) <[email protected]>

* Refactor Terraform module documentation rendering

* Add conditional caching based on label presence

---------

Co-authored-by: Erik Osterman (CEO @ Cloud Posse) <[email protected]>
* fix broken links

* fix broken links

* fix broken links

* format design decisions, optimize side bar

* fix sidebar positions

* ordering and index pages

* iconify everything

* add more icons, reduce size

* add a few more icons, fix margin
Co-authored-by: Erik Osterman (CEO @ Cloud Posse) <[email protected]>
@osterman osterman merged commit 8bc80a5 into master Aug 9, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants