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

Docs/schema change #412

Merged
merged 8 commits into from
Dec 23, 2024
Merged

Docs/schema change #412

merged 8 commits into from
Dec 23, 2024

Conversation

PGijsbers
Copy link
Collaborator

@PGijsbers PGijsbers commented Dec 10, 2024

Change

Adds documentation on how to change the schema when adding an attribute to an existing entity.

How to Test

Make sure you install the documentation dependencies (pip install -e ".[docs]" or refer to pyproject.toml).
Read and follow the documentation, see if it works, makes sense, and is intuitive.

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

See comment below.

@PGijsbers PGijsbers requested a review from Taniya-Das December 10, 2024 12:32
@PGijsbers
Copy link
Collaborator Author

Some images for pages like the README currently do not load. This is because with the current organisation they could not render from the docs/readme.md page at the same time as from the docs/developer/index.md page. This would either require a separate post-processing plugin or to restructure the documentation. I will do this in a follow up PR. The documentation is currently not published anyway.

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.

The documentation instructions are clear to me.

docs/developer/schema/attributes.md Outdated Show resolved Hide resolved
@PGijsbers PGijsbers marked this pull request as ready for review December 16, 2024 14:56
@PGijsbers
Copy link
Collaborator Author

PGijsbers commented Dec 16, 2024

@Taniya-Das Can I have an review looking at:

  • The new readme (docs landing page, docs/readme.md)
  • The new contributor guide (docs/contributing.md)
  • The trimmed old dev guide (docs/developers/index.md).. it's still in progress but i moved some stuff out and pics should work
  • Whether you think the current level of work-in-progress is acceptable for a merge.
    Reason that I would want to merge is that I don't have the time to finish the rewrite this week, and others might be more inclined/find it easier to help this way.

Other material wasn't changed (much) since last review. Thank you very much!

@PGijsbers PGijsbers merged commit 28ef235 into develop Dec 23, 2024
2 checks passed
@PGijsbers PGijsbers deleted the docs/schema-change branch December 23, 2024 08:17
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