8000 Reorganize Docs by osterman · Pull Request #243 · cloudposse/atmos · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Reorganize Docs #243

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

Merged
merged 21 commits into from
Nov 11, 2022
Merged

Reorganize Docs #243

merged 21 commits into from
Nov 11, 2022

Conversation

osterman
Copy link
Member
@osterman osterman commented Nov 9, 2022

what

  • Reorganize docs

## what
* Reorganize docs
@osterman osterman requested review from a team as code owners November 9, 2022 18:01
@osterman osterman requested review from Gowiem and woz5999 and removed request for a team November 9, 2022 18:01
@osterman osterman temporarily deployed to preview November 9, 2022 18:01 Inactive
< 10000 a class="avatar avatar-user" style="width:20px;height:20px;" data-test-selector="commits-avatar-stack-avatar-link" data-hovercard-type="user" data-hovercard-url="/users/cloudpossebot/hovercard" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="/cloudpossebot"> @cloudpossebot
@cloudpossebot cloudpossebot temporarily deployed to preview November 9, 2022 18:02 Inactive
@@ -1,6 +1,6 @@
---
title: "atmos aws eks update-kubeconfig"
sidebar_label: "aws eks update-kubeconfig"
sidebar_label: "`aws eks update-kubeconfig`"
Copy link
Member
@aknysh aknysh Nov 9, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

all commands are auto-generated from a JSON file.
We'll need to update the generator code

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. then we need to have a preamble on all files that are auto-generated that says so
  2. where do I update these docs?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

all of the commands are described in this JSON file https://github.com/cloudposse/atmos/blob/update-website/website/src/cli/cli.json

The generator code is here https://github.com/cloudposse/atmos/blob/update-website/website/src/cli/cli.mjs

We can continue using it (we used it before in the old website as well), or we can just create an MD file for each command and populate them manually.

Copy link
Member
@aknysh aknysh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please see comments

@osterman osterman temporarily deployed to preview November 9, 2022 18:38 Inactive
@osterman osterman temporarily deployed to preview November 10, 2022 13:25 Inactive
@osterman osterman temporarily deployed to preview November 10, 2022 13:51 Inactive
@osterman osterman merged commit aa8f326 into update-website Nov 11, 2022
@osterman osterman deleted the reorg-docs branch November 11, 2022 17:00
aknysh added a commit that referenced this pull request Nov 11, 2022
* Update website

* Update website

* Update website

* Update website

* Update website

* Update website

* Updates

* Update docs website

* Update docs website

* Updates

* Updates

* Update docs

* Update docs

* Update docs

* Update docs

* Update docs

* Update docs

* Update docs

* Update docs website

* Update docs website

* Update docs website

* Added docs for running docusaurus. (#242)

* Auto Format

* Add index_content.mdx

* Add index_content.mdx

* Updates

* Updates

* Updates

* Updates

* Updates

* Updates

* Updates

* Updates

* Updates

* Updates

* Reorganize Docs (#243)

* fix links

* Updates

* fix broken links

* fix broken links

* Updates

* Updates

* add office hours video

Co-authored-by: Erik Osterman (CEO @ Cloud Posse) <erik@cloudposse.com>
Co-authored-by: cloudpossebot <11232728+cloudpossebot@users.noreply.github.com>
@osterman osterman added the documentation Improvements or additions to documentation label Nov 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants
0