Page MenuHomeSoftware Heritage

Create user page in docs for dedicated user documentation
Open, NormalPublic

Description

User documentation can be:

  • manuals for end-users of the product
  • manuals for the system administrators.
  • User documentation includes tutorials, user guides, troubleshooting manuals, installation, and reference manuals.
  • FAQs
  • Video tutorials
  • Embedded assistance
  • Support Portals

In the docs sprint we have decided on the following structure for the user page:

proposed structure of user main page

(https://docs.softwareheritage.org/user/)
(https://docs.softwareheritage.org/usage/)
(https://docs.softwareheritage.org/service/)
How to use the SWH archive(non-technical)

  • Getting started (tutorials)
    • searching an origin
    • browsing code
  • Howto
    • get and choose a swhid
    • list visits
    • save code now
      • with the web platform
      • with the API
    • search metadata
  • Explanation
    • why SWH?
    • architecture
    • pull vs push
    • delay/lag
    • ...

Event Timeline

moranegg triaged this task as Normal priority.Mar 18 2021, 12:17 PM
moranegg created this task.

Redirect https://archive.softwareheritage.org/browse/help/ to the user documentation