grafana / grafana/k6-docs

Change "Installation" to "Install" in page titles

Open
#910 0 comments 0 reactions 0 assignees View on GitHub
Tech Writers
Dominant language
Python
Stars
117
Forks
266
Avg merge
4d 11h
Merged PRs (30d)
9

Description

We should make our get started sections have all verb titles. Noun forms are naturally more ambiguous, and everywhere in the docs except here we use imperative verbs to introduce procedures. The reasoning relates to the removal of Gerunds described in #818.

- [ ] Update file paths and Page titles
- [ ] Fix all instances of internal links to new path
- [ ] Program redirects in `gatsby-node.js`
- [ ] Test that these redirects work in staging, and that they don't introduce any broken links (much easier now that we have a linkchecker).

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the get started page titles and paths that use “Installation,” then review gatsby-node.js for the redirect entry points. Update the paths, titles, and internal links, and use the staging site and linkchecker to confirm redirects work without broken links.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, node.js
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.