SFDO-Community-Sprints / Membership-Essentials-App

Open Source Community Sprint project focused on building a schema for memberships, renewals, payments, multiple members, families, benefits, etc, that actually works. Eventually automation.
BSD 3-Clause "New" or "Revised" License
24 stars 13 forks source link

Move documentation to github.io pages #82

Open kreynen opened 1 year ago

kreynen commented 1 year ago

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.

Screen Shot 2022-11-03 at 3 25 12 PM

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.

kreynen commented 1 year ago

In the 1/10 team meeting, Erin Rameriz agreed to work with me on this.

kreynen commented 1 year ago

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.

kreynen commented 1 year ago

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.