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

Clean up README and INSTALL documents #34

Open
mbjones opened this issue Oct 1, 2024 · 0 comments
Open

Clean up README and INSTALL documents #34

mbjones opened this issue Oct 1, 2024 · 0 comments
Assignees
Labels
D-2.2 Deployed and refactored, open-source VegBank documentation mgmt
Milestone

Comments

@mbjones
Copy link
Member

mbjones commented Oct 1, 2024

README file cleanup

The current README.md is a template and needs to be updated with vegbank-specific details. These include:

  • Link to vegbank2 Discussions rather than DataONE Discussions
  • Fix names/URLS for the 3 repositories
  • Change "Usage Example" to "API Usage" and write something like TBD under it

Later we'll clean up more things including the author list and citation details

INSTALL file cleanup

  • Bring instructions from helm/README.md into INSTALL.md
  • Reorganize into 3 clean sections
    1. Data migration -- How to take a Postgres dump file from the original VB DB, and (locally) create a version of this that is compatible with and loadable into the new PG version
    2. Chart installation -- How to deploy Postgres to K8s using Helm, as part of our new VegBank storage service
    3. Database restore -- How to restore a current DB dump file (i.e., what you produce in step 1, or by creating a dump file from the new system) to the Postres instance running on K8s (i.e., what you have after running step 2)
  • Clean up the Docker instructions in the current INSTALL file ... at least rid of the console output, and make it clear that this is an alternative to the local installation of PG/Flyway
  • Add instruction to tar/compress the dump file before copying over to the cluster
  • Do some minor formatting cleanup
    • Add code tags
    • Use section delimiters where appropriate (##)
    • Remove trailing whitespace
@mbjones mbjones moved this to Ready in VegBank Project Oct 1, 2024
@mbjones mbjones added this to the v2.0.0alpha02 milestone Oct 1, 2024
@mbjones mbjones added D-2.2 Deployed and refactored, open-source VegBank documentation labels Oct 1, 2024
@regetz regetz added the mgmt label Nov 25, 2024
@regetz regetz changed the title update README with discussion forum and other details Clean up README and INSTALL documents Dec 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
D-2.2 Deployed and refactored, open-source VegBank documentation mgmt
Projects
Status: Ready
Development

No branches or pull requests

3 participants