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 numbers to the deployment instructions #141

Closed
Tracked by #67
surchs opened this issue Dec 4, 2023 · 2 comments
Closed
Tracked by #67

[ENH] Add numbers to the deployment instructions #141

surchs opened this issue Dec 4, 2023 · 2 comments
Labels
_flag:stale [BOT ONLY] Flag issue that hasn't been updated in a while and needs to be triaged again good first issue Good issue for a new contributor.

Comments

@surchs
Copy link
Contributor

surchs commented Dec 4, 2023

Steps to be numbered:

  1. Install dependencies / tools to deploy (see Add a section for installing the necessary tools to deploy #142)
  2. Configure the config files
  3. Launch the stack
  4. Go through the first time deployment config
  5. Test the deployment

Notes from Thomas: Add a first step (step 0) / or a heading to install dependencies: docker, docker-compose, plus whatever else you need. This should always be at the start of an installation page (normally under a brief intro of what you are about to install).

Other documentation pages should also be checked to ensure any links to previous un-numbered sections of the infrastructure.md page are updated.

@surchs surchs added this to Neurobagel Dec 4, 2023
@surchs surchs changed the title Add numbers to each step. i.e. 1. get a license 2. Launch the api stack (for the public docs as well as this one). I suggest this because, the heading "Launch the API stack" can be a bit confusing to users, since they want to install it, and aren't thinking of "API" yet [ENH] Add numbers to the deployment instructions Dec 4, 2023
@alyssadai alyssadai added the good first issue Good issue for a new contributor. label Dec 6, 2023
Copy link

We want to keep our issues up to date and active. This issue hasn't seen any activity in the last 75 days.
We have applied the _flag:stale label to indicate that this issue should be reviewed again.
When you review, please reread the spec and then apply one of these three options:

  • prioritize: apply the flag:schedule label to suggest moving this issue into the backlog now
  • close: if the issue is no longer relevant, explain why (give others a chance to reply) and then close.
  • archive: sometimes an issue has important information or ideas but we won't work on it soon. In this case
    apply the someday label to show that this won't be prioritized. The stalebot will ignore issues with this
    label in the future. Use sparingly!

@github-actions github-actions bot added the _flag:stale [BOT ONLY] Flag issue that hasn't been updated in a while and needs to be triaged again label Apr 28, 2024
@surchs
Copy link
Contributor Author

surchs commented May 8, 2024

Closed in #189

@surchs surchs closed this as completed May 8, 2024
@github-project-automation github-project-automation bot moved this to Review - Done in Neurobagel May 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
_flag:stale [BOT ONLY] Flag issue that hasn't been updated in a while and needs to be triaged again good first issue Good issue for a new contributor.
Projects
Archived in project
Development

No branches or pull requests

2 participants