replicatedhq / replicatedhq/replicated-docs

docs: improve enterprise portal docs with visual imagery

Open
#3,972 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
MDX
Stars
12
Forks
35
Avg merge
1d 1h
Merged PRs (30d)
113

Description

Our docs are very well rounded in many places, catering to all kinds of learners (book learners, visual learners with pictures, hands-on learners with examples and tutorials).

There are a few gaps here or there, but it's by-and-large a poster example of writing docs for all learning types.

One gap that stood out to me was that some of the Enterprise Portal docs don't have as many screenshots for visual learners.

Ex: https://docs.replicated.com/embedded-cluster/v3/installing-embedded-air-gap

Image

#5 is excellent, but it might be an improvement for visual learners to add some more screenshots, for instance #4 mentions "At the top", and a screenshot would help drive it home.

There's a hidden feature I think with the visual imagery, too. When you're working on something and scanning tons of docs, when you see a screenshot matching what it is your currently working through, it immediately registers that you're on the right page. Whereas if the details are hidden in text, sometimes it may be missed initially by a visual type.

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start with the Enterprise Portal page at docs.replicated.com/embedded-cluster/v3/installing-embedded-air-gap and compare the numbered installation steps, especially #4 and #5. Identify places where the text refers to screen locations such as "At the top" and add screenshots that make those steps easier to follow; done means the relevant Enterprise Portal docs provide useful visual guidance for visual learners.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.