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

Add more in-depth documentation about clouud-enabled hubs #92

Open
5 tasks
bsweger opened this issue Mar 6, 2024 · 0 comments
Open
5 tasks

Add more in-depth documentation about clouud-enabled hubs #92

bsweger opened this issue Mar 6, 2024 · 0 comments
Labels
cloud documentation Improvements or additions to documentation

Comments

@bsweger
Copy link
Contributor

bsweger commented Mar 6, 2024

We recently merged a hubDocs PR to include some high-level information about the recent v2.0.1 schema revision (i.e., adding the cloud section to admin.json).

While that change acknowledges the existence of cloud-enabled hubs, it's lacking some important details. Once the cloud infrastructure is further developed (perhaps once the parquet data conversion process is enabled?) we should ensure that hubDocs includes enough information for people to understand what a cloud-enabled hub offers and how it works.

For example:

  • Actual contact information for people who want Hubverse hosting
  • Step-by-step for cloud onboarding? (copy the GitHub action, update admin.json)
  • Breakdown of what the GitHub action does (including answers to some of the good questions from a recent demo, like "what happens if there are multiple merges at the same time")
  • Security note
  • Documentation about any data conversions happening once hub date is in S3 (e.g., formatting as parquet)
@bsweger bsweger converted this from a draft issue Mar 6, 2024
@bsweger bsweger added the documentation Improvements or additions to documentation label Mar 6, 2024
@bsweger bsweger added the cloud label Mar 22, 2024
@bsweger bsweger added this to the hubverse cloud sync milestone Apr 5, 2024
@mmkerr mmkerr self-assigned this Jun 5, 2024
@mmkerr mmkerr removed their assignment Aug 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cloud documentation Improvements or additions to documentation
Projects
Status: Todo
Status: Backlog
Development

No branches or pull requests

2 participants