search

redhataccess / pantheon-cmd

Pantheon CMD is an open source and freely distributed program for validating and building local previews of modular documentation.
GNU General Public License v3.0
2 stars 5 forks source link

content prerequisites #64

Open ryandeussing opened 2 years ago

ryandeussing commented 2 years ago

I'd like to know, and possibly it would be helpful to add to the README:

  1. What are prerequisites to build a guide or a doc set with pantheon-cmd? If one follows a/the modularization checklist, should it work? Or are the new/additional requirements?

  2. Is it possible for a repo to be suitably modularized for pantheon-cmd to function, while still publishing in PV1?

Thanks!

adahms commented 2 years ago

Hey @ryandeussing - great questions.

Some answers ahead of a fuller update to the README -

  1. Your content should be modularised in accordance with the modular documentation templates, but as long as it's beaten into the shape of identifiable modules and assemblies (i.e. the filename prefix or attribute for modules), PCMD can help validate their structure as well. You'll also need a pantheon2.yml file to identify where your content lives, and the main attributes file to supply - https://github.com/redhataccess/pantheon/blob/master/pantheon-bundle/src/main/resources/SLING-INF/content/docs/modules/con_pantheon_yaml_file.adoc
  2. Yes - a number of teams do this today. Even if your modules and assemblies are combined into PV1 titles, PCMD looks at the individual assembly and module files. As long as it can find them via a pantheon2.yml file, you're good.

Happy to run over how this works or offer some examples as well if that'd help.

ryandeussing commented 2 years ago

Thanks @adahms - I'm going to find time after next week to start some care and feeding of the Insights repo, and one outcome I hope to achieve is to get pantheon-cmd working. And then validate that writers can begin using it, or figure out how I can help get us to that point.