What's new

Active Doc-Support-Website

FlorentG74

New Pivian
Code:
Title: PIVX Documentation and Support Dedicated Website
Name: Doc-Support-Website
Term: 4
Cycle Amnt: 1 421
Total Amnt: 5 684
Author: FlorentG74
Receiver: FlorentG74
Address: DMrbxvoa11gLfRq4ortzBa1e41neb5MoP9
Created: 14 Jun 2021
Status: Active

Overview​

PIVX 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:
  1. Finding resources is a complicated process and
  2. Deprecated resources are left behind and remain online, confusing users.
I wrote an assessment of the current documentation process - available on GitHub: https://github.com/FlorentG74/PIVX-Wiki/blob/master/PIVX-Documentation-Proposal.md
This proposal aims at:
  1. Delivering a documentation website that would offer unified documentation to all PIVX users (new users, advanced users, masternode owners)
  2. Putting in place a maintenance process making it easy for maintainers/contributors to evolve the documentation at the same time as the software

Objectives​

These 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

Deliverables​

The 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
An update on the progress and on the usage/distribution of the funds will be provided on the forum on a monthly basis.

Approach & Budget/Resources​


Task
Description
Person in Charge/Beneficiary
Estimated Effort
Distribution
Website - Initial Framework
  • Deliver a website based on Grav CMS (a file-based CMD that is based on the Markdown format)
  • Develop a theme for the CMS that integrates with the PIVX color chart
PalmTree​
30 hrs.​
2*250 =
500 PIV
Website - Enhancements throughout the proposal
  • Implement enhancements to the basic framework throughout the course of the proposal
FlorentG74/PalmTree depending on requirements​
30 hrs.​
500 PIV
Knowledge Base - Structure
  • Define a structure for the knowledge base, and create site map/placeholder pages
FlorentG74​
5 hrs.​
74 PIV
Knowledge Base - Migration from forum
  • Migrate all up-to-date articles from the forum to the new pages
  • Flag the deprecated content for suppression
FlorentG74
Open to contributors for 30 PIV/Article​
18 articles / 30 PIV per article​
540 PIV
Knowledge Base - Review of Youtube videos
  • Review Youtube videos / flag the deprecated ones for suppression
  • Where available and relevant, integrate the video on corresponding wiki page
FlorentG74
Open to contributors​
20 hrs.​
300 PIV
Knowledge Base - Troubleshooting section
  • Review the questions on the Support forum/Discord and incorporate the frequent/relevant ones into the doc articles/troubleshooting sections
FlorentG74​
20 hrs.​
300 PIV
Knowledge Base - Add Content
  • Proposal is to organize the documentation in 10 different sections
  • Each section would have a lead contributor receiving a distribution after works has been peer-reviewed
  • The 10 sections would be:
    • Introduction to PIVX/Main Concepts - 150 PIV
    • Getting started - 600 PIV
    • Using the QT Core Wallet - 500 PIV
    • Staking - 400 PIV
    • Using the Command Line Core Wallet - 300 PIV
    • RPC Client - 400 PIV
    • Governance - 200 PIV
    • Masternodes - 200 PIV
    • Best Practices / FAQ - Shared work among all contributors, no explicit distribution
    • Glossary - Shared work among all contributors, no explicit distribution
FlorentG74
Call to contributors​
Up to 2750
Project Management
  • Coordination of the contributors
  • Coordination of the reviews
  • Coordination with the community for questions/clarifications etc.
  • Definition of the framework for the longer term maintenance of the documentation
FlorentG74​
48 hrs.​
4*180 =
720 PIV


Total
Total AmountCycle Amount
5 684 PIV1 421

Current State​

Some of the work on the website has been started. The basic framework is in place and page templates have been created for the most common types of pages:

Standard page with multiple section/navigation menu:
Capture d’écran 2021-06-14 à 23.10.40.png


Search Page:
Capture d’écran 2021-06-14 à 23.09.02.png


FAQ Page with collapsible sections:
Capture d’écran 2021-06-14 à 23.13.05.png


Tutorial section that makes it easy to have images and description/steps side-by-side:
Capture d’écran 2021-06-14 à 23.14.52.png

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 objectives

The 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 items

The 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 myself

I'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.

Voting:​

Proposal Name: Doc-Support-Website
hash: 4ba2da13725e212b546ab639094621259753016e18daf36b044017d0126a1e58

To vote YES:
Code:
mnbudgetvote many 4ba2da13725e212b546ab639094621259753016e18daf36b044017d0126a1e58 yes

To vote NO:
Code:
mnbudgetvote many 4ba2da13725e212b546ab639094621259753016e18daf36b044017d0126a1e58 no

To check status:
Code:
getbudgetinfo Doc-Support-Website
 
Last edited:

palmtree

Administrator
Staff member
When looking for support or tutorials, it's often frustrating when you follow documents which lead to dead ends or are incomplete and you have to piece together 2 or 3 parts of different websites to get a solution or resolution. I'm not sure how other coin projects keep their documentation, but I do know that PIVX documentation in recent times is quite fragmented and deprecated. A great example of well managed documentation is the "Arch User Repository" and the "Arch Wiki". For example, search "Arch openvpn" and you will almost always be brought to the most appropriate document or resource. Some attempts have been made by disabling deprecated websites but at the same time disabling the only resource that contained certain other documents. With upcoming features, I think this becomes even more important as additional complications and questions will undoubtedly rise.
 

FlorentG74

New Pivian
When looking for support or tutorials, it's often frustrating when you follow documents which lead to dead ends or are incomplete and you have to piece together 2 or 3 parts of different websites to get a solution or resolution. I'm not sure how other coin projects keep their documentation, but I do know that PIVX documentation in recent times is quite fragmented and deprecated. A great example of well managed documentation is the "Arch User Repository" and the "Arch Wiki". For example, search "Arch openvpn" and you will almost always be brought to the most appropriate document or resource. Some attempts have been made by disabling deprecated websites but at the same time disabling the only resource that contained certain other documents. With upcoming features, I think this becomes even more important as additional complications and questions will undoubtedly rise.
Yes @palmtree that's why I put migration of legacy docs as part of it. It's a pain to land on a deprecated doc, almost less frustrating to find nothing and ask support!
 
Top