-
Notifications
You must be signed in to change notification settings - Fork 13
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
Move documentation to github.io pages #82
Comments
In the 1/10 team meeting, Erin Rameriz agreed to work with me on this. |
https://github.com/SFDO-Community-Sprints/summit-events-app-documentation/blob/main/_config.yml#L17 deploys that documentation as a directory of the site created by https://github.com/SFDO-Community-Sprints/sfdo-community-sprints.github.io/ https://github.com/SFDO-Community-Sprints/DLRS-Documentation deploys to the https://sfdo-community-sprints.github.io/DLRS-Documentation/ directory. https://github.com/SFDO-Community-Sprints/DataGenerationToolkit generates https://sfdo-community-sprints.github.io/DataGenerationToolkit/DataGenGuide AFAICT, https://github.com/SFDO-Community/GrassrootsMobileSurveyApp/wiki still uses a wiki. |
After talking to @tcdahlberg, I started https://github.com/SFDO-Community-Sprints/MembershipSchemaAndBenefits-Documentation from https://github.com/just-the-docs/just-the-docs-template/generate. I'll work with @eramirez-arkus to document the process for rebuilding/rewriting the documentation currently in the wiki as Markdown including using Metecho to review a feature. For users who don't have the Salesforce CLI tools running, getting up to speed on the what the package does might be easier than trying to debug the type of issues we were running into in San Francisco during a virtual conference. |
When the Use Case documentation was added to the wiki, it ended up "under the fold" and required clicking on the "X more pages" link.
The Summit Events project recently moved from https://github.com/SFDO-Community/Summit-Events-App/wiki to https://sfdo-community-sprints.github.io/summit-events-app-documentation/ managed in https://github.com/SFDO-Community-Sprints/summit-events-app-documentation/.
While there are some tricks we can use to clean this up a bit, there are real limits to the GitHub Wiki functionality and advantages to moving the documentation to a github.io pages site.
The text was updated successfully, but these errors were encountered: