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

Start consolidation of documentation #391

Merged
merged 12 commits into from
Nov 21, 2024
Merged

Start consolidation of documentation #391

merged 12 commits into from
Nov 21, 2024

Conversation

PGijsbers
Copy link
Collaborator

Change

Expand on the documentation, and start consolidating it into one place.
The current state is not yet ready for public consumption, but I think the idea is clear and ready for feedback.

While I would not require it to be perfect, I do think we need a little extra effort to modify existing documentation to better make use of the new structure. The follow up would be to do improve that integration and set up an automatic build and deploy workflow.

How to Test

Locally:

python -m pip install mkdocs-material
python -m mkdocs serve

Visit http://localhost:8000/docs (assuming you do not have the metadata catalogue service running locally).
You can browse the documentation.

Since these are documentation changes, they do not warrant additional tests.
In fact, I disabled unit tests from the pre-commit hook if only markdown files are changed in a commit.

Checklist

  • Tests have been added or updated to reflect the changes, or their absence is explicitly explained.
  • Documentation has been added or updated to reflect the changes, or their absence is explicitly explained.
  • A self-review has been conducted checking:
    • No unintended changes have been committed.
    • The changes in isolation seem reasonable.
    • Anything that may be odd or unintuitive is provided with a GitHub comment explaining it (but consider if this should not be a code comment or in the documentation instead).
  • All CI checks pass before pinging a reviewer, or provide an explanation if they do not.

Related Issues

N/A

@PGijsbers PGijsbers requested a review from Taniya-Das November 14, 2024 12:27
@PGijsbers PGijsbers marked this pull request as ready for review November 20, 2024 15:06
Copy link
Collaborator

@Taniya-Das Taniya-Das left a comment

Choose a reason for hiding this comment

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

Looks good to me.

alembic/README.md Outdated Show resolved Hide resolved
docs/Using.md Outdated Show resolved Hide resolved
@PGijsbers PGijsbers merged commit adf4e0c into develop Nov 21, 2024
4 checks passed
@PGijsbers PGijsbers deleted the docs branch November 21, 2024 14:11
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.

2 participants