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

Move documentation to github.io pages #82

Open
kreynen opened this issue Nov 3, 2022 · 3 comments
Open

Move documentation to github.io pages #82

kreynen opened this issue Nov 3, 2022 · 3 comments
Assignees
Labels

Comments

@kreynen
Copy link
Contributor

kreynen commented Nov 3, 2022

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 kreynen self-assigned this Jan 10, 2023
@kreynen
Copy link
Contributor Author

kreynen commented Jan 10, 2023

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

@kreynen
Copy link
Contributor Author

kreynen commented Feb 10, 2023

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants