Title: PIVX Documentation and Support Dedicated Website Name: PIVX-Doc-Support-Website Term: 4 Cycle Amnt: 1 421 Total Amnt: 5 684 Author: FlorentG74 Receiver: FlorentG74 Address: DMrbxvoa11gLfRq4ortzBa1e41neb5MoP9 Created: 31 May 2021 Status: Draft
OverviewPIVX documentation is available in in a variety of medias, including the PIVX forum - mostly for end-users (i.e. step by step tutos) and the Github wiki (more technical info).
It can make the experience of adopting/using PIVX frustrating as:
- Finding resources is a complicated process and
- Deprecated resources are left behind and remain online, confusing users.
This proposal aims at:
- Delivering a documentation website that would offer unified documentation to all PIVX users (new users, advanced users, masternode owners)
- Putting in place a maintenance process making it easy for maintainers/contributors to evolve the documentation at the same time as the software
ObjectivesThese are the objectives my proposal aims at meeting:
- Have all user documentation aggregated in one place (technical and non-technical documentation)
- Offer a structure that is easy to navigate for both new and advanced users:
- An easy to navigate map with a chronological journey for new users
- A clean structure allowing easy access to any section of the documentation
- Search capabilities
- Support multiple formats of documentation (Text/Images/Videos)
- Make maintenance easy and accessible to persons with limited technical knowledge; reduce/suppress dependency on Core Developers for maintenance
- Use existing documentation resources as much as possible
DeliverablesThe main deliverables for this proposal will be:
- An integrated knowledge base which will
- Replace the documentation available on the forum/in the github wiki
- Be based on GitHub/the md documentation format (re-purposing the existing https://github.com/PIVX-Project/PIVX-Wiki that contains mostly deprecated information)
- Have a maintenance process that allow for external contributions (via pull requests) while implementing tight controls
- A standalone website (linked to the main PIVX website), serving the content from the knowledge base:
- A CMS delivering the objectives listed above (Documentation display/navigation/search)
- A synchronisation with GIT allowing for auto-refresh of the documentation without requiring intervention from a developer. Mechanism for refresh:
- The website will have a local git repository containing the documents.
- Addition/Update of documents will be deployed to the website via a 'git pull' from the remote hosted on GitHub (either via a cron or a web hook mechanism)
- A maintenance process for the documentation that will contain the following information:
- Structure of the documentation website
- Process to add/update/remove documentation
Approach & Budget/Resources
Person in Charge/Beneficiary
|Website - Initial Framework|
|Website - Enhancements throughout the proposal|
FlorentG74/PalmTree depending on requirements
|Knowledge Base - Structure|
|Knowledge Base - Migration from forum|
Open to contributors for 30 PIV/Article
18 articles / 30 PIV per article
|Knowledge Base - Review of Youtube videos|
Open to contributors
|Knowledge Base - Troubleshooting section|
|Knowledge Base - Add Content|
Call to contributors
|Up to 2750|
|Total Amount||Cycle Amount|
|5 684 PIV||1 421|
Assumptions & Risks
- Hosting/linking to the main website: As per discussions with @palmtree and @Kyeno, hosting and integration on the main website are unlikely to require specific budget lines.
- Some of the deliverables (the content ones) depend heavily on the community. While I will strive to get the whole scope delivered in 4 terms there is a possibility that some topics will not be covered during the lifespan of the proposal. Any budget remaining after the full term will be used to either complete the deliverables listed above, or be used towards some of the stretch objectives if all deliverables have been completed.
Potential Stretch objectivesThe following objectives will be considered if time allows but are not covered by the proposal/budget request (in particular as they have dependencies on Core/Web developers)
- Update the Core Wallet to include a link to the documentation website
- Update the Core Wallet FAQ to point to a wiki page to simplify maintenance
- Have a bot repost the messages from the support section of the forum on Discord to ensure all support requests are seen by the team
Out of scope itemsThe following items should be considered as out of the scope of this proposal:
- Developer documentation (contribution/translation/compilation etc)
- New Youtube videos; I don't have the skills / time and believe this should be part of a separate proposal
About myselfI'm a relatively new member of the PIVX community, and am a strong believer in the value of PIVX.
While researching the coin/setting up my wallet for staking I have experienced first-hand the challenges new PIVX adopters can face in terms of documentation.
I have contributed to the PIVX project as a translator during the month of May (on both the Core Wallet and the website), which gave me visibility on all the content available online to the PIVX community.