-
Notifications
You must be signed in to change notification settings - Fork 23
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
[DO NOT MERGE] compliance docs for confidential survey tool #33
Conversation
I added some records for SA-5 and RA-5, but this is still a very early version. Is this how I am supposed to extend this though? |
@harrisj, LGTM. You are on the right track! |
This is looking really good. Perhaps add a page like https://compliance.cloud.gov/system_documentation/system-description.html for the readme text and system/data flow diagrams? Other thoughts, @18F/ato ? |
Sounds good to me. How do I add that page? |
@harrisj I believe you need to add a markdown file in |
Do I want to add a new file? Or do I edit/replace the On Fri, Feb 19, 2016 at 8:44 PM, David Best notifications@github.com
|
Add a new one, @harrisj. The cloud.gov ones are chock full of good info that is still relevant to your application. |
* Added the confidential survey page to the summary so that it'll show up in the gitbook. * Changed the system classification from Medium to Low. * Corrected the image links. * Corrected a few spacing issues.
@harrisj I committed a few minor fixes. Looks good to me. Any other thoughts, @18F/ato ? |
Thanks! |
references: | ||
- verification: code_climate | ||
- verification: gemnasium | ||
- verification: hakiri |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe this file should be called static-analysis/component.yml
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's a good idea, it could be more generic for other applications to apply
I can't speak to whether this meets the Masonry format or whether anything's missing, but aside from my few minor comments, this looks good! I'm assuming we shouldn't try and merge this since this repository is cloud.gov-specific, but am curious on @geramirez's thoughts. Also, does the existence of the Masonry files mean that https://pages.18f.gov/before-you-ship/ato/ssp/ is no longer needed? |
Re: the SSP, it seems like we aren't capturing all of the information in the Masonry files that are in the Tangentially, is there somewhere in the Masonry files that need to (essentially) say "this is using cloud.gov under the hood, so inherit from it"? Not seeing the equivalent of the list of |
@afeld - Yeah, I don't think we should try to merge it. All the info in the info We don't have anything that deals specifically with a cloud.gov dependency yet. However, I'm thinking we could use the Thoughts? |
Thanks for the feedback, @afeld and @DavidEBest! I have tweaked this PR a bit accordingly |
@geramirez I think that is the way to go (re: package.json) we have the composability in the tool but no way of describing where to get stuff... |
Created a card to convert this to the new format: https://trello.com/c/0HRG3Tak/142-convert-confidential-survey-ato-documentation-to-new-format |
Can we close this? |
First test of https://trello.com/c/I7EujTnt/59-try-creating-masonry-files-for-a-real-application.
Working branch. Comment here when you'd like some 👀 on it!
/cc @harrisj @18F/ato