Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor Documentation for better UX #1146

Open
ejlee3 opened this issue Jun 20, 2023 · 1 comment
Open

Refactor Documentation for better UX #1146

ejlee3 opened this issue Jun 20, 2023 · 1 comment
Labels
enhancement New feature or request

Comments

@ejlee3
Copy link
Contributor

ejlee3 commented Jun 20, 2023

🚀 Feature Request

Relevant Package [REQUIRED]

This feature request is for...

all the docs!

Description [REQUIRED]

A clear and concise description of the problem or missing capability...
  • re-read and potentially (if resources allow) do UX tests on the getting started instructions - is this something we want to keep up to date? (old references to past releases, previous go versions, and previous docker versions
  • improve security section
  • improve overarching style - do we want any instructions numbered? should we avoid the use of long paragraphs in the instructions? how can this be more user friendly - these steps and these steps required multiple read-throughs before the instructions were semi-clear
  • improve the organization of each chapter - many chapters - like security, examples and tutorials to name a couple, seem to have pages in a random order - is there a way to group pages or better organize things so that users get a better sense of what information is present?

Describe the solution you'd like

If you have a solution in mind, please describe it.
  • determine a way to group information or present it better
  • determine a consistent way to organize the documentation
  • focus on usability and readability - both of which aren't the easiest if unfamiliar with the project

Things that are hard to find:

  • it is hard to find information on the different targets or option with compose builder - is this documented anywhere? or is that up to the developers to figure out?
  • it's pretty hard to find configuration information and appropriate values - if you don't know what you are looking for, it is nearly impossible to find without looking instead at the source code
  • what are all the different compose-builder options- is there a list anywhere - how can users leverage this tool to help them build images for securing services or using services in a non-secure way.

Describe alternatives you've considered

Have you considered any alternative solutions or workarounds?
@ejlee3 ejlee3 added the enhancement New feature or request label Jun 20, 2023
@lenny-goodell
Copy link
Member

Great start,Thanks @ejlee3!!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants