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.

Sign up for GitHub

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

Fix broken links to info on environment variables #62

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Fix broken links to info on environment variables #62

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
27bf938
Fix broken links to info on environment variables
maccabeelevine Feb 22, 2024
7db2f30
Change link per Craig's suggestion
maccabeelevine Jan 6, 2025
ea369ba
Fix link in this template also
maccabeelevine Jan 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion MODULE_ACCEPTANCE_CRITERIA.MD
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ Note: Backend criteria apply to modules, shared backend libraries, and edge modu
* -_note: read more at https://github.com/folio-org/okapi/blob/master/okapi-core/src/main/raml/ModuleDescriptor.json_
* Module includes executable implementations of all endpoints in the provides section of the Module Descriptor
* Environment vars are documented in the ModuleDescriptor (5, 11)
* -_note: read more at [https://wiki.folio.org/pages/viewpage.action?pageId=65110683](https://wiki.folio.org/pages/viewpage.action?pageId=65110683)_
* -_note: read more at [https://folio-org.atlassian.net/wiki/spaces/SYSOPS/pages/2097733/Change+Environment+Variables+of+a+Module](https://folio-org.atlassian.net/wiki/spaces/SYSOPS/pages/2097733/Change+Environment+Variables+of+a+Module)_
Copy link
Contributor

Choose a reason for hiding this comment

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

See my comment about the correct(?) page. Also, this notation is redundant if the link text and URL are identical

* If a module provides interfaces intended to be consumed by other FOLIO Modules, they must be defined in the Module Descriptor "provides" section, and must conform to FOLIO [interface naming conventions](https://dev.folio.org/guidelines/naming-conventions/#interfaces) (3, 5)
* All API endpoints are documented in OpenAPI (11)
* All API endpoints protected with appropriate permissions as per the following guidelines and recommendations, e.g. avoid using *.all permissions, all necessary module permissions are assigned, etc. (6)
Expand Down
2 changes: 1 addition & 1 deletion MODULE_EVALUATION_TEMPLATE.MD
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ When performing a technical evaluation of a module, create a copy of this docume
* -_note: read more at https://github.com/folio-org/okapi/blob/master/okapi-core/src/main/raml/ModuleDescriptor.json_
* [ ] Module includes executable implementations of all endpoints in the provides section of the Module Descriptor
* [ ] Environment vars are documented in the ModuleDescriptor
* -_note: read more at [https://wiki.folio.org/pages/viewpage.action?pageId=65110683](https://wiki.folio.org/pages/viewpage.action?pageId=65110683)_
* -_note: read more at [https://folio-org.atlassian.net/wiki/spaces/SYSOPS/pages/2097733/Change+Environment+Variables+of+a+Module](https://folio-org.atlassian.net/wiki/spaces/SYSOPS/pages/2097733/Change+Environment+Variables+of+a+Module)_
Copy link
Contributor

Choose a reason for hiding this comment

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

I believe @craigmcnally 's comment about the correct page also applies here.
I might also suggest using the link syntax to show the page name rather than having the much longer URL text displayed in-line:
DR-000020 -Teams must document deployment requirements in a clear consistent way

* [ ] If a module provides interfaces intended to be consumed by other FOLIO Modules, they must be defined in the Module Descriptor "provides" section, and must conform to FOLIO [interface naming conventions](https://dev.folio.org/guidelines/naming-conventions/#interfaces).
* [ ] All API endpoints are documented in OpenAPI.
* [ ] All API endpoints protected with appropriate permissions as per the following guidelines and recommendations, e.g. avoid using `*.all` permissions, all necessary module permissions are assigned, etc.
Expand Down