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

Warn about quotes interpretation in README instructions for using API docker image directly #224

Closed
2 tasks done
alyssadai opened this issue Nov 15, 2023 · 3 comments · Fixed by #284
Closed
2 tasks done
Labels
bug:docs Typos or errors in documentation. released This issue/pull request has been released. type:bug Defects in shipped code and fixes for those defects

Comments

@alyssadai
Copy link
Contributor

alyssadai commented Nov 15, 2023

In the below sections of the README, we should explicitly instruct users to not wrap any space-separated values for variables in the .env file in quotation marks:

See our internal wiki https://github.com/neurobagel/documentation/wiki/Docker#docker-cli-docker-run for why the quotes are a problem

Originally posted by @surchs in neurobagel/federation-api#22 (review)

@alyssadai alyssadai added type:bug Defects in shipped code and fixes for those defects bug:docs Typos or errors in documentation. labels Nov 15, 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 Jan 30, 2024
@samadpls
Copy link
Contributor

samadpls commented Mar 6, 2024

Hi @alyssadai, I have created a PR #284 related to this ticket. Could you please review it when it's convenient for you?
Thanks so much!

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

surchs commented Apr 11, 2024

🚀 Issue was released in v0.2.0 🚀

@surchs surchs added the released This issue/pull request has been released. label Apr 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug:docs Typos or errors in documentation. released This issue/pull request has been released. type:bug Defects in shipped code and fixes for those defects
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants