Update documentation for deprecated contact_details field#723
Open
KushanSingh-Kalvium wants to merge 1 commit intoaiondemand:developfrom
Open
Update documentation for deprecated contact_details field#723KushanSingh-Kalvium wants to merge 1 commit intoaiondemand:developfrom
KushanSingh-Kalvium wants to merge 1 commit intoaiondemand:developfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Change(s)
Change Type: Changed
Change Category: Documentation
Changelog Entry:
Update documentation regarding the deprecated
contact_detailsfield onPersonandOrganisation.A schema note was added explaining that
contact_detailshas been removedand that contacts should instead be defined through the generic
contactsmapping at the
AIResourcelevel.The migration guide now documents how existing one-to-one
contact_detailsmappings are migrated to the many-to-many contact linktable.
The upload documentation has also been updated to remove references to
contact_detailsand show usage of thecontactsfield instead.How to Test
mkdocs buildto verify the documentation builds successfully.mkdocs serveand openhttp://127.0.0.1:8000.contact_details.Checklist
Tests are not required because this change only affects documentation.
Related Issues
Closes #563