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

Enhance Hugo doc process to handle and preserve multiple versions of past docs (readme and typedoc files) #731

Open
11 tasks
Tracked by #400
jeromy-cannon opened this issue Oct 22, 2024 · 0 comments
Labels
good first issue candidate Issues that can become a good first issue but need more description/context. hacktoberfest Issues shown by lists for the Hacktoberfest and made for newcomers to do the first contribution. P2 Required to be completed in the assigned milestone, but may or may not impact release schedule.

Comments

@jeromy-cannon
Copy link
Contributor

jeromy-cannon commented Oct 22, 2024

🆕🐥 First Timers Only

This issue is reserved for people who have never contributed to Hedera or any open source project in general.
We know that creating a pull request (PR) is a major barrier for new contributors.
The goal of this issue and all other issues labeled by 'Good First Issue' is to help you make your first contribution to Hedera.

👾 Description of the issue

Solo's current GitHub Pages generated by Hugo only support a single version which is latest. We wish to be able to default to latest but to have the option of selecting previous versions of the doc somewhere on the landing page and to retain these versions of the docs. The docs are to include the main pages as well as the classes files generated by TypeDoc.

Steps to reproduce

  1. in a terminal cd into the directory that is the root of your local solo repository
  2. cd docs to switch to the directory that has all of the docs
  3. install Taskfile if you don't already have it: https://taskfile.dev/installation/
  4. task start will run the Hugo build and dependencies and then give you locally hosted URL at the bottom. Click the link to see a local copy of the docs which should reflect what you see if you go here: https://hashgraph.github.io/solo/

Proposed Solution:

  1. https://hashgraph.github.io/solo/ should redirect to https://hashgraph.github.io/solo/latest
  2. there should be a dropdown selector that has latest selected that will contain a list of previous versions of the documentation, understanding that previous version prior to our next release may not be available
  3. the version dropdown should be under the Search text box and above the Navigation menu
  4. changing the dropdown to a previous version should change the documentation page to the version selected and all of links on that page and child pages should work correctly
  5. prior versions of the docs should be maintained and captured as part of these changes

📋 Step by step guide to do a contribution

If you have never contributed to an open source project at GitHub, the following step-by-step guide will introduce you to the workflow. More information and concrete samples for shell commands for each step can be found in our CONTRIBUTING.md file.
A more detailed general documentation of the GitHub PR workflow can be found here.

  • Claim this issue: Comment below that you are interested in working on the issue
  • Wait for assignment: A community member with the given rights will add you as an assignee of the issue
  • Fork the repository: You can do that in GitHub (by simply clicking the 'fork' button).
  • Check out the forked repository
  • Create a feature branch for the issue. We do not have a hard naming definition for branches but it is best practice to prefix the branch name with the issue id.
  • Solve the issue in your branch.
  • Commit your changes: Here, it is needed to add sign-off information to the commit to accept the "Developer Certificate of Origin" (https://developercertificate.org). More details can be found in our CONTRIBUTING.md
  • Start a Pull Request (PR): We have a pattern for naming pull requests that a GitHub Action checks. We use that pattern to support the creation of automatic release notes.
  • Check GitHub Actions: Several GitHub Actions will be triggered automatically for each PR. If a GitHub Action fails and you do not understand the cause of that error do not hesitate to add a comment to the PR and ask the Hedera developer community for support.
  • Wait for reviews: Members of the Hedera developer community will review your PR. If a reviewer finds any missing pieces or a problem, he or she will start a discussion with you and describe the next steps for solving the problem.
  • You did it 🎉: We will merge the fix in the develop branch. Thanks for being part of the Hedera community as an open-source contributor ❤️

🎉 Contribute to Hacktoberfest

Solve this issue as part of the Hacktoberfest event and get a chance to receive cool goodies like a T-Shirt. 🎽

🤔 Additional Information

If you have any questions, just ask us directly in this issue by adding a comment. You can join our community chat at Discord. A general manual about open-source contributions can be found here.

@jeromy-cannon jeromy-cannon added P2 Required to be completed in the assigned milestone, but may or may not impact release schedule. good first issue candidate Issues that can become a good first issue but need more description/context. hacktoberfest Issues shown by lists for the Hacktoberfest and made for newcomers to do the first contribution. labels Oct 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue candidate Issues that can become a good first issue but need more description/context. hacktoberfest Issues shown by lists for the Hacktoberfest and made for newcomers to do the first contribution. P2 Required to be completed in the assigned milestone, but may or may not impact release schedule.
Projects
None yet
Development

No branches or pull requests

1 participant