Enhance Hugo doc process to handle and preserve multiple versions of past docs (readme and typedoc files) #731
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.
🆕🐥 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 tolatest
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
cd
into the directory that is the root of your local solo repositorycd docs
to switch to the directory that has all of the docstask 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:
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📋 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.
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🎉 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.
The text was updated successfully, but these errors were encountered: