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

Add documentation on customisations #103

Merged
merged 2 commits into from
Jan 15, 2025
Merged

Add documentation on customisations #103

merged 2 commits into from
Jan 15, 2025

Conversation

cc-a
Copy link
Collaborator

@cc-a cc-a commented Jan 7, 2025

  • Issue: [Link to the issue. Do not use any of the github automation keywords]

This PR adds a documentation framework (mkdocs) and adds detailed documentation covering the customisations made from base InvenioRDM.

Developer Checklist

Developers should review and confirm each of these items before requesting review

  • Code meets acceptance criteria from issue
  • Unit tests are written and all pass
  • User Test Scripts (if required) are written and have been run through
  • Code documentation and related non-code documentation has all been updated

Reviewer Checklist

Reviewers should review and confirm each of these items before approval
If there are multiple reviewers, this section can be duplicated for each reviewer

  • Code meets acceptance criteria from issue
  • Unit tests are written and all pass
  • User Test Scripts (if required) are written and have been run through
  • Code documentation and related non-code documentation has all been updated
  • Migation has been created and tested

Testing

List user test scripts that need to be run

List any non-unit test scripts that need to be run

@cc-a cc-a enabled auto-merge January 15, 2025 16:37
@cc-a cc-a merged commit 5324915 into develop Jan 15, 2025
2 checks passed
@cc-a cc-a deleted the docs branch January 15, 2025 16:41
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