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.

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

Add templating tokens into the FedRamp document to allow Masonry to render into it. #140

Closed
DavidEBest opened this issue May 12, 2016 · 5 comments
Assignees
Labels

Comments

@DavidEBest
Copy link

DavidEBest commented May 12, 2016

Here are the relevant links:

@afeld
Copy link
Member

afeld commented May 12, 2016

/cc #117

@afeld afeld self-assigned this May 23, 2016
@afeld
Copy link
Member

afeld commented May 25, 2016

Nice-to-have:

The FedRAMP docx is already "templatized" in the sense that it contains text like <Information System Abbreviation> and <Date of PA>. Would be nice to be able to handle those template fields provided by FedRAMP, in addition to the template fields ({{getControl "..."}}) that we will be inserting manually.

Similarly, the docx may have a consistent enough structure that we can parse the XML and find where each control should be inserted, which could save a lot of time, especially if they release a new version of the docx. I'm sure we don't want to have to drop the template tags in there manually more than once.

@afeld
Copy link
Member

afeld commented May 25, 2016

Starting an experiment to automate the Go templating here: https://github.com/opencontrol/fedramp-templater

@afeld
Copy link
Member

afeld commented Jun 23, 2016

I'm starting to think that inserting template tags will be insufficient for the FedRAMP docx (opencontrol/fedramp-templater#10), and that having a FedRAMP-specific Masonry formatter/plugin (#153) is the way to go.

Current workflow

...or at least the one we had been working towards.

  1. Download Masonry and the fedramp-templater.
  2. Run fedramp-templater on original FedRAMP docx, which inserts the template tags.
  3. Run Masonry on the templatized docx, producing the final result.

Proposed workflow

  1. Download Masonry and the FedRAMP formatter/plugin.
  2. Run compliance-masonry docs fedramp on the original (or even a partially-filled) docx.
  3. The plugin parses and fills in the file, producing the final result.

The benefit here is that we can do all of the parsing and filling of the docx in a single pass, rather than requiring an intermediate format with special tags inserted for all of the information we want to insert. We can still break the Golang-style docx templating support into its own plugin...it just doesn't make sense for the FedRAMP doc.

@mogul mogul added the HighBar label Jul 8, 2016
@afeld
Copy link
Member

afeld commented Jul 20, 2016

Closing in favor of opencontrol/fedramp-templater#18.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants