Enable "Edit on GitHub" in more pages

Open
#24 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
github, html
Domain
documentation, web-dev

Research direction

Review how Edit on GitHub is enabled for the completed FAQs, Guides, and Blog posts, then inspect the help converter needed for the User Guide. Determine how footer or manual links should cover remaining pages and data files; done means the outstanding pages have usable links to their relevant GitHub sources.

Written by the indexing model from the issue text.

Description

documentation enhancement

Enable on:

  • FAQs
  • Guides
  • User Guide (requires changes in help converter)
  • Blog posts
  • ?

How about we add a link (in the footer maybe?) to the relevant github file so people can easily suggest changes?
Hopefully these can be automated, but in some cases (like the evangelists) we'd need to add manual links to the relevant data files.

Dominant language
HTML
Stars
82
Forks
132
Avg merge
13h 14m
Merged PRs (30d)
37

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from zaproxy/zaproxy-website

All issues in zaproxy/zaproxy-website

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.