search

aragon / help

Documentation and files related to help.aragon.org
Creative Commons Zero v1.0 Universal
3 stars 7 forks source link

Mirror help.aragon.org with github.com/aragon/help #5

Closed john-light closed 5 years ago

sohkai commented 5 years ago

Not sure how HelpScout works, but technically these files are not markdown files (they're HTML snippets). It would be nice to transform these back into markdown if HelpScout accepts markdown.

Are we doing the mirroring automatically, or is the plan to make changes here and then manually propagate the changes to HelpScout?

john-light commented 5 years ago

@sohkai that is correct they are html not markdown (as such they should probably be .html rather than .md but chose that extension out of habit). HelpScout will only take HTML for precise formatting. Anyways these files are only here to facilitate pull requests on the content itself by people who don't have direct access to HelpScout, so I didn't bother changing the file extension since it (afaict) doesn't really matter.

The changes are currently being mirrored to HelpScout manually, and vice versa. From this repo's readme:

After a pull request that fixes help.aragon.org documentation is merged, the help.aragon.org maintainer(s) will copy the content over so that the documentation stays up to date. Changes made on Help Scout directly should also be copied over to this repository by the author and submitted as a pull request for review.