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

[ENH] Add advanced-settings docs #115

Merged
merged 48 commits into from
Apr 7, 2023
Merged

Conversation

viniciusdc
Copy link
Contributor

@viniciusdc viniciusdc commented Aug 11, 2022

Reference Issues or PRs

fixes #102
closes #103
closes #255

also,

closes #68
closes #277
closes #279

What does this implement/fix?

Put an 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 to not 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?

related to #88

@viniciusdc viniciusdc linked an issue Aug 11, 2022 that may be closed by this pull request
1 task
@netlify
Copy link

netlify bot commented Aug 11, 2022

Deploy Preview for nebari-dev ready!

Name Link
🔨 Latest commit d858abe
🔍 Latest deploy log https://app.netlify.com/sites/nebari-dev/deploys/62fabb6da50e4d0009b353e9
😎 Deploy Preview https://deploy-preview-115--nebari-dev.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 settings.

@netlify
Copy link

netlify bot commented Aug 11, 2022

Deploy Preview for nebari-docs ready!

Name Link
🔨 Latest commit 555c5fd
🔍 Latest deploy log https://app.netlify.com/sites/nebari-docs/deploys/6422e5043e117200071dbda9
😎 Deploy Preview https://deploy-preview-115--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 settings.

@viniciusdc viniciusdc changed the title [ENH] Adding advanced-settings docs [ENH] Adding advanced-settings docs - WIP Aug 12, 2022
Copy link
Contributor

@kcpevey kcpevey left a comment

Choose a reason for hiding this comment

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

Submitting review for advanced configuration.

docs/docs/explanations/advanced-configuration.md Outdated Show resolved Hide resolved
docs/docs/explanations/advanced-configuration.md Outdated Show resolved Hide resolved
docs/docs/explanations/advanced-configuration.md Outdated Show resolved Hide resolved
docs/docs/explanations/advanced-configuration.md Outdated Show resolved Hide resolved
docs/docs/explanations/advanced-configuration.md Outdated Show resolved Hide resolved
docs/docs/explanations/advanced-configuration.md Outdated Show resolved Hide resolved
docs/docs/explanations/advanced-configuration.md Outdated Show resolved Hide resolved
docs/docs/explanations/advanced-configuration.md Outdated Show resolved Hide resolved
docs/docs/explanations/advanced-configuration.md Outdated Show resolved Hide resolved
docs/docs/explanations/advanced-configuration.md Outdated Show resolved Hide resolved
@kcpevey
Copy link
Contributor

kcpevey commented Sep 9, 2022

Find/replace all instances of QHub that are not inside of command names

Copy link
Contributor

@kcpevey kcpevey left a comment

Choose a reason for hiding this comment

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

Review complete. Thanks @viniciusdc for all of this great information! You did a great job covering a ton of material!

docs/docs/explanations/configuration-best-practices.mdx Outdated Show resolved Hide resolved
docs/docs/explanations/configuration-best-practices.mdx Outdated Show resolved Hide resolved
docs/docs/explanations/configuration-best-practices.mdx Outdated Show resolved Hide resolved
docs/docs/explanations/configuration-best-practices.mdx Outdated Show resolved Hide resolved
docs/docs/explanations/configuration-best-practices.mdx Outdated Show resolved Hide resolved
docs/docs/explanations/configuration-best-practices.mdx Outdated Show resolved Hide resolved
docs/docs/explanations/configuration-best-practices.mdx Outdated Show resolved Hide resolved
docs/docs/explanations/configuration-best-practices.mdx Outdated Show resolved Hide resolved
@kcpevey kcpevey added needs: changes 🧱 Review completed - some changes are needed before merging and removed needs: review 👀 labels Sep 9, 2022
@pavithraes pavithraes added this to the 🪴 Nebari rename milestone Oct 17, 2022
@viniciusdc
Copy link
Contributor Author

Thanks, @kcpevey I will be updating this today.

@pavithraes pavithraes mentioned this pull request Oct 19, 2022
18 tasks
...
```

## Dask profiles
Copy link
Contributor

Choose a reason for hiding this comment

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

We need to add a cross reference in the Dask docs back to this config. I made a note of it here .

@kcpevey
Copy link
Contributor

kcpevey commented Jan 23, 2023

@pavithraes is ready for another review?

@pavithraes
Copy link
Member

@pavithraes is ready for another review?

Thanks for checking in! Not yet, one more commit with some miscellaneous+minor tweaks is in progress -- I'll ping you in a day or so with that!

@pavithraes
Copy link
Member

pavithraes commented Mar 14, 2023

@kcpevey @viniciusdc This PR isn't perfect, but please feel free to review and we can start iteratively merging sections/pages that look good.

Copy link
Contributor

@kcpevey kcpevey left a comment

Choose a reason for hiding this comment

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

Thanks @pavithraes! This is a great PR. A lot of work has gone into this and its a LOT of content. I'd love to see it get merged soon!

docs/docs/explanations/advanced-custom-settings.md Outdated Show resolved Hide resolved
docs/docs/explanations/advanced-custom-settings.md Outdated Show resolved Hide resolved
docs/docs/explanations/advanced-custom-settings.md Outdated Show resolved Hide resolved
docs/docs/explanations/advanced-custom-settings.md Outdated Show resolved Hide resolved
docs/docs/explanations/advanced-custom-settings.md Outdated Show resolved Hide resolved

Local deployment is intended for Nebari deployments on a "local" cluster created and management by Kind.
It is great for experimentation and development.

Copy link
Contributor

Choose a reason for hiding this comment

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

Insert some comment here about Macs - @iameskild can you do this?

Copy link
Member

Choose a reason for hiding this comment

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

I'll add a note saying this is only supported on linux right now, like in: http://localhost:3000/docs/how-tos/nebari-local#compatibility

Let me know if you'd like to add something more. :)

docs/docs/explanations/advanced-security-configuration.md Outdated Show resolved Hide resolved
docs/docs/explanations/configuration-best-practices.mdx Outdated Show resolved Hide resolved
docs/docs/faq.md Outdated Show resolved Hide resolved
docs/docs/faq.md Show resolved Hide resolved
@pavithraes pavithraes requested a review from kcpevey March 28, 2023 13:00
@pavithraes pavithraes added needs: review 👀 This PR is complete and ready for reviewing and removed status: in progress 🏗 This task is currently being worked on needs: changes 🧱 Review completed - some changes are needed before merging labels Mar 28, 2023
@pavithraes
Copy link
Member

@kcpevey Thanks for the review, I've made the suggested updates, ready for another round. :)

Copy link
Contributor

@kcpevey kcpevey left a comment

Choose a reason for hiding this comment

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

LGTM. Let's merge this baby!!

@pavithraes pavithraes changed the title [ENH] Adding advanced-settings docs [ENH] Add advanced-settings docs Apr 7, 2023
@pavithraes pavithraes merged commit 31762e0 into main Apr 7, 2023
@pavithraes pavithraes deleted the docs-102-advanced-settings branch April 7, 2023 00:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment