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

[REF] Remove environment variable table from README #168

Merged
merged 7 commits into from
Sep 10, 2023

Conversation

alyssadai
Copy link
Contributor

@alyssadai alyssadai commented Sep 8, 2023

Closes #153

Changes proposed in this pull request:

  • Moved environment variables table into separate TSV file to link to from the official docs using mkdocs-yamp
  • Simplified README to link to docs section on environment variables (which includes a copy of info about configuring origins, etc.) to keep README focused on installation and launch steps
  • Moved info for deploying a query tool as part of the Compose network to the docker compose section

Checklist

  • PR has an interpretable title with a prefix ([ENH], [FIX], [REF], [TST], [CI], [MNT], [INF], [MODEL], [DOC]) (see https://neurobagel.org/contributing/pull_requests for more info)
  • PR links to GitHub issue with mention Closes #XXXX
  • Tests pass
  • Checks pass

For new features:

  • Tests have been added

For bug fixes:

  • There is at least one test that would fail under the original bug conditions.

@coveralls
Copy link
Collaborator

coveralls commented Sep 8, 2023

Pull Request Test Coverage Report for Build 6125792347

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 100.0%

Totals Coverage Status
Change from base Build 6113947017: 0.0%
Covered Lines: 368
Relevant Lines: 368

💛 - Coveralls

Copy link
Collaborator

@rmanaem rmanaem left a comment

Choose a reason for hiding this comment

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

🧑‍🍳

@alyssadai alyssadai merged commit 27ee42b into main Sep 10, 2023
4 checks passed
@alyssadai alyssadai deleted the ref-153/remove-env-var-table branch September 10, 2023 03:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove table for environment variables and link to docs instead
3 participants