Fix broken links to info on environment variables #62
Conversation
|
I think this might be the page you're looking for: https://folio-org.atlassian.net/wiki/spaces/TC/pages/5055298/DR-000020+-+Teams+must+document+deployment+requirements+in+a+clear+consistent+way |
MODULE_ACCEPTANCE_CRITERIA.MD
Outdated
| @@ -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)_ | |||
There was a problem hiding this comment.
See my comment about the correct(?) page. Also, this notation is redundant if the link text and URL are identical
craigmcnally
dismissed
their stale review
Suggested changes after initial approval
There was a problem hiding this comment.
Echoing @craigmcnally 's comment that DR-000020 -Teams must document deployment requirements in a clear consistent way should be the correct link.
MODULE_EVALUATION_TEMPLATE.MD
Outdated
| @@ -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)_ | |||
There was a problem hiding this comment.
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
|
Thanks @craigmcnally @todolson I changed the link as recommended. Not going to resolve the conflicts yet as there will just be new ones when we merge the other doc PRs i.e. #86 |
| @@ -86,11 +86,11 @@ 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/TC/pages/5055298/DR-000020+-+Teams+must+document+deployment+requirements+in+a+clear+consistent+way_ | |||
There was a problem hiding this comment.
This change is not needed because the master branch has the correct link.
| * 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) | ||
| * -_note: read more at https://dev.folio.org/guidelines/naming-conventions/ and https://wiki.folio.org/display/DD/Permission+Set+Guidelines_ | ||
| * -_note: read more at https://dev.folio.org/guidelines/naming-conventions/ and https://wiki.folio.org/display/DD/Permission+Set+Guidelines _ |
There was a problem hiding this comment.
The space before the tailing underscore is not a valid syntax for markdown emphasis formatting.
I believe this is the correct destination page after the wiki migration, but @dltj could not confirm.