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

restructure_docs #228

Merged
merged 8 commits into from
Jan 18, 2021
Merged

restructure_docs #228

merged 8 commits into from
Jan 18, 2021

Conversation

laisbsc
Copy link
Contributor

@laisbsc laisbsc commented Jan 6, 2021

PR for docs restructure. Ready for review in parts.

For now, the aim of this PR is to:

@laisbsc laisbsc marked this pull request as ready for review January 11, 2021 18:18
@laisbsc laisbsc requested review from teoliphant, tylerpotts and aktech and removed request for teoliphant January 11, 2021 18:19
@laisbsc laisbsc moved this from In progress to Requires review and/or changes in QHub Board Roadmap Jan 13, 2021
@laisbsc laisbsc linked an issue Jan 15, 2021 that may be closed by this pull request
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.

I wrote these this morning, but just realize I must have never clicked "submit"! I hope they aren't out of date now!

README.md Outdated Show resolved Hide resolved
README.md Outdated

`qhub` is installed as a command line application in Python. It requires you to choose your the cloud provider you desire. once you've decided on a provider `qhub` will walk you through the following steps to configure your deployment:
## On-Premises
QHub On-Prem is based on OpenHPC.
Copy link
Contributor

Choose a reason for hiding this comment

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

do we need to rename qhub-hpc to qhub-onprem? we had to go through explaining to our client who didn't have an hpc system that the hpc approach used here would work well for them (@costrouc ).

If all hpc aspects under the hood and this can be applied to a single large machine, maybe hpc is misleading? Just a thought.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@dharhas do you have any thoughts on this? Shall we rename it?

README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
docs/docs/do/configuration.md Show resolved Hide resolved
docs/docs/do/configuration.md Show resolved Hide resolved
docs/docs/do/configuration.md Show resolved Hide resolved
docs/docs/do/configuration.md Show resolved Hide resolved
docs/docs/faqs.md Show resolved Hide resolved
@laisbsc laisbsc merged commit 1b8717b into nebari-dev:master Jan 18, 2021
QHub Board Roadmap automation moved this from Requires review and/or changes to Done Jan 18, 2021
This was referenced Jan 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation 📖 Improvements or additions to documentation
Projects
No open projects
2 participants