HOLD - Documentation version 1 - Limited pilot with prototyping partners #102
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
* Modify homepage tag line in translations Updated the homepage tag line in both English and French translations to remove 'Protected B' as everything is now protected B, no need to differentiate. * API key refresh EN * Revise API key refresh to key rotation FR Updated the section on API key management to clarify the process of key rotation and its necessity. * Update API key instructions in getting-started.md Clarified API key generation instructions and security note. * Add API key requirement to documentation
anikbrazeau
temporarily deployed
to
github-pages
anikbrazeau
temporarily deployed
to
github-pages
* Modify homepage tag line in translations Updated the homepage tag line in both English and French translations to remove 'Protected B' as everything is now protected B, no need to differentiate. * API key refresh EN * Revise API key refresh to key rotation FR Updated the section on API key management to clarify the process of key rotation and its necessity. * Update API key instructions in getting-started.md Clarified API key generation instructions and security note. * Add API key requirement to documentation * Document file retrieval process for submissions - EN Added section on retrieving attached files from submissions, including security considerations and example response data. * Add details on retrieving form submission attachments - FR Added section on retrieving attachments from form submissions, including security considerations and example response data. * Revise documentation on form submission file retrieval Updated section headers and clarified file retrieval process. * Enhance security section for file retrieval Clarified the process of retrieving attached files securely, emphasizing the importance of checking the isPotentiallyMalicious attribute for safety. * Enhance security instructions for file analysis Added guidance on handling the 'isPotentiallyMalicious' attribute for security. * Update warning about file analysis responsibility Clarified responsibility for checking the 'isPotentiallyMalicious' attribute before opening linked files. * Clarify file scanning responsibility in documentation Clarified responsibility for checking the isPotentiallyMalicious attribute in file scanning. * Update file retrieval explanation in documentation Clarified that files are retrieved from AWS and updated the wording for better understanding. * Update explanation for retrieving attached files Clarified that files are retrieved from AWS and linked to responses. * Update file retrieval instructions with guidance link Added a link to the Guidance page for file uploads in form submissions. * Update API file retrieval instructions Added a reference link to the guide for uploading files in the API section. * Revise JSON example for file attachments Updated the JSON structure for file attachments in the documentation, adding fields for 'id', 'downloadLink', and 'md5'. * Revise JSON example for file attachments Updated the JSON structure for attached files in the documentation. * File scanning warning * Apply suggestion from @anikbrazeau * Apply suggestion from @anikbrazeau
anikbrazeau
temporarily deployed
to
github-pages
* Update Base URL for authentication endpoint * Change base URL to include versioning Updated the base URL for the API documentation.
anikbrazeau
temporarily deployed
to
github-pages
Fixed a broken link in the documentation regarding file retrieval and updated the guidance page link.
anikbrazeau
had a problem deploying
to
github-pages
anikbrazeau
had a problem deploying
to
github-pages
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.
Description
First version of the documentation site is deploying from
docsbranch. This PR would bring it into themainbranch so that it's more in the open.https://cds-snc.github.io/forms-api/
Implications
If this PR gets merged, it will require updating the "Settings" for the repo to deploy the "main" branch instead of "docs". There is some remaining work to be done to rework the architecture to modernize it -- a few things in the config file are not even needed.
Reference links
https://docs.google.com/document/d/1HbTmNL8rSnYl_GnCT0hACPL6CNq1j6UOiR8-w0DqWgQ/edit?tab=t.0
https://github.com/cds-snc/pspc-documentation/tree/master
https://github.com/cds-snc/talent
https://github.com/cds-snc/rcmp-report-a-cybercrime-alpha-documentation