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

installation doc issues #122

Open
robsimmonds opened this issue Jun 20, 2022 · 2 comments
Open

installation doc issues #122

robsimmonds opened this issue Jun 20, 2022 · 2 comments
Assignees

Comments

@robsimmonds
Copy link

Have marked up some problems and suggestions in these pdfs.

Installation — CARTA Controller 3.0.0-beta.3 documentation.pdf
Step-by-step instructions for CentOS 8 — CARTA Controller 3.0.0-beta.3 documentation.pdf
Step-by-step instructions for Ubuntu 20.04.2 (Focal Fossa) — CARTA Controller 3.0.0-beta.3 documentation.pdf

@confluence
Copy link
Collaborator

A partial list of fixes (apart from typos, missing packages, etc.):

  • Add manual line breaks to long lines in code samples so that they don't get malformed in the PDF
  • Simplify the RHEL/CentOS instructions as much as possible to make them more closely aligned with the Ubuntu instructions
  • Add an overview section to the installation page which explains what the components are and what OSes are supported, and links to the step-by-step instructions
  • Revise or remove the starting paragraph on the landing page

@confluence
Copy link
Collaborator

Bumping this. We really should revise the more general installation page so that people stop trying to use it as a step-by-step tutorial. The links to the detailed instructions should be more prominent, and not inside the backend section. All literal code snippets on that page should be clearly marked as examples and not complete instructions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Status: Icebox
Development

No branches or pull requests

2 participants