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

Argo docs update #350

Merged
merged 8 commits into from
Sep 8, 2023
Merged

Argo docs update #350

merged 8 commits into from
Sep 8, 2023

Conversation

kcpevey
Copy link
Contributor

@kcpevey kcpevey commented Aug 10, 2023

The Argo docs are lacking in depth and clarity. This PR adds more details on how things work and more examples on how to run a workflow on Argo using python.

Reference Issues or PRs

What does this implement/fix?

Put a x in the boxes that apply

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds a feature)
  • Breaking change (fix or feature that would cause existing features not to work as expected)
  • Documentation Update
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no API changes)
  • Build related changes
  • Other (please describe):

Testing

  • Did you test the pull request locally?
  • Did you add new tests?

Documentation

Access-centered content checklist

Text styling

  • The content is written with plain language (where relevant).
  • If there are headers, they use the proper header tags (with only one level-one header: H1 or # in markdown).
  • All links describe where they link to (for example, check the Nebari website).
  • This content adheres to the Nebari style guides.

Non-text content

  • All content is represented as text (for example, images need alt text, and videos need captions or descriptive transcripts).
  • If there are emojis, there are not more than three in a row.
  • Don't use flashing GIFs or videos.
  • If the content were to be read as plain text, it still makes sense, and no information is missing.

Any other comments?

@kcpevey kcpevey self-assigned this Aug 10, 2023
@kcpevey
Copy link
Contributor Author

kcpevey commented Aug 10, 2023

The yarn linter caught some files that I didn't modify.

@netlify
Copy link

netlify bot commented Aug 10, 2023

Deploy Preview for nebari-docs ready!

Name Link
🔨 Latest commit 4085445
🔍 Latest deploy log https://app.netlify.com/sites/nebari-docs/deploys/64fb4a677679510007498148
😎 Deploy Preview https://deploy-preview-350--nebari-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@pavithraes pavithraes added type: enhancement 💅🏼 New feature or request status: in progress 🏗 This task is currently being worked on area: integration/Argo labels Aug 17, 2023
@pavithraes pavithraes mentioned this pull request Aug 17, 2023
18 tasks
@kcpevey kcpevey marked this pull request as ready for review August 21, 2023 16:30
@kcpevey
Copy link
Contributor Author

kcpevey commented Aug 21, 2023

This is ready for review. I created an argo-assistant package which is in good shape, but isn't fully fleshed out (https://github.com/nebari-dev/nebari-argo-assistant). However, JATIC is moving away from Argo so I have to wrap all this up. I've chosen to avoid mention of the separate package in the docs for now and instead add all the necessary code into the docs. Its not the best option, but at least the docs will explain how to use Argo for realistic usecases.

@kcpevey kcpevey added status: in review 👀 This PR is currently being reviewed by the team and removed status: in progress 🏗 This task is currently being worked on labels Aug 21, 2023
Copy link
Member

@pavithraes pavithraes left a comment

Choose a reason for hiding this comment

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

Thank you for such a thorough set of docs, @kcpevey!

Most suggestions are minor, so I'll approve and we can merge when ready. :)

@pavithraes pavithraes added needs: changes 🧱 Review completed - some changes are needed before merging and removed status: in review 👀 This PR is currently being reviewed by the team labels Sep 8, 2023
Co-authored-by: Pavithra Eswaramoorthy <[email protected]>
@kcpevey
Copy link
Contributor Author

kcpevey commented Sep 8, 2023

Thanks for the help @pavithraes ! I've accepted all of your changes.

@pavithraes pavithraes added status: approved 💪🏾 This PR has been reviewed and approved for merge and removed needs: changes 🧱 Review completed - some changes are needed before merging labels Sep 8, 2023
@pavithraes pavithraes merged commit b834864 into main Sep 8, 2023
5 checks passed
@pavithraes pavithraes deleted the argo_docs branch September 8, 2023 16:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: integration/Argo status: approved 💪🏾 This PR has been reviewed and approved for merge type: enhancement 💅🏼 New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants