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

Find & update documentation for sites who want to upgrade the theme themselves, and make sure it's posted in our support documentation. #1713

Closed
MirandaEcho opened this issue May 22, 2019 · 3 comments
Assignees
Labels
Estimate: < 2 Hours priority: high Either blocks work on a priority-normal task or a solution here informs other work. status: in progress status: needs docs
Milestone

Comments

@MirandaEcho
Copy link
Collaborator

No description provided.

@MirandaEcho MirandaEcho added this to the 0.6.4 milestone May 22, 2019
@benlk benlk changed the title Find & update documentation for sites who want to upgrade the theme themselves, and make sure its its posted in our support documentation. Find & update documentation for sites who want to upgrade the theme themselves, and make sure its posted in our support documentation. May 24, 2019
@benlk benlk changed the title Find & update documentation for sites who want to upgrade the theme themselves, and make sure its posted in our support documentation. Find & update documentation for sites who want to upgrade the theme themselves, and make sure it's posted in our support documentation. Jun 6, 2019
@benlk
Copy link
Collaborator

benlk commented Jun 6, 2019

  • add SUPPORT file for https://help.github.com/en/articles/adding-support-resources-to-your-project that sends people to largo.inn.org for docs, largo.readthedocs.io for developer documentation, and support@inn.org if they have questions not covered by the above
  • add this update docs to largo.inn.org
    • it's probably in Helpscout somewhere
    • there's also probably a version in github user @benlk's gists, or in INN/largo/tree/0.5-dev/docs
  • reference those update docs in the release notes and release blog post
    • add task to release notes issue to make sure that the update docs are included in those

@MirandaEcho
Copy link
Collaborator Author

@benlk benlk added the priority: high Either blocks work on a priority-normal task or a solution here informs other work. label Jun 19, 2019
@benlk benlk self-assigned this Jul 12, 2019
@benlk
Copy link
Collaborator

benlk commented Jul 17, 2019

as seen in https://github.com/benlk/test-rst-health-files/issues/new:

  • GitHub does support using .rst in Community Health Files
  • GitHub does support drawing Community Health Files from multiple different folders in a repo

Therefore:

  • to prevent duplication of support resources within the repo, the SUPPORT file should be placed in docs/ in a reStructuredText format so that it gets picked up by the largo.readthedocs.io build

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Estimate: < 2 Hours priority: high Either blocks work on a priority-normal task or a solution here informs other work. status: in progress status: needs docs
Projects
None yet
Development

No branches or pull requests

2 participants