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

docs: rework README #617

Merged
merged 8 commits into from
Jul 4, 2021
Merged

docs: rework README #617

merged 8 commits into from
Jul 4, 2021

Conversation

casperdcl
Copy link
Contributor

@casperdcl casperdcl commented Jun 28, 2021

  • update sections
    • create, simplify & unify installation/setup into just 2 sections (basic at top & advanced at bottom)
    • more intuitive section names
  • document cml-pr
  • mark all "see also" examples which require PATs

follow-up (after this PR) #652

@casperdcl casperdcl temporarily deployed to internal June 28, 2021 20:41 Inactive
@casperdcl casperdcl temporarily deployed to internal June 28, 2021 20:43 Inactive
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@casperdcl casperdcl self-assigned this Jun 28, 2021
@casperdcl casperdcl added documentation Markdown files p1-important High priority labels Jun 28, 2021
@casperdcl casperdcl temporarily deployed to internal June 29, 2021 13:44 Inactive
@casperdcl casperdcl temporarily deployed to internal June 29, 2021 13:48 Inactive
README.md Show resolved Hide resolved
@casperdcl casperdcl temporarily deployed to internal June 29, 2021 14:02 Inactive
@casperdcl casperdcl temporarily deployed to internal June 29, 2021 14:05 Inactive
@casperdcl casperdcl temporarily deployed to internal June 29, 2021 14:09 Inactive
@casperdcl casperdcl temporarily deployed to internal June 29, 2021 15:04 Inactive
README.md Show resolved Hide resolved
@0x2b3bfa0 0x2b3bfa0 temporarily deployed to internal June 30, 2021 20:06 Inactive
@casperdcl casperdcl temporarily deployed to internal June 30, 2021 21:10 Inactive
@0x2b3bfa0 0x2b3bfa0 temporarily deployed to internal June 30, 2021 23:46 Inactive
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
@DavidGOrtega
Copy link
Contributor

DavidGOrtega commented Jul 1, 2021

Personally I still see some flaws being the most delicate the Advanced section. Too much stuff there including Installation that should not be advanced at all 😁

Section CML reports before Getting started is a non sense to me. It does not mention cml-github-send-check either.

My logic structure

CML presentation and areas of development defining the three legs that CML has:

  • metrics integration (tb and many to come)
  • reports
  • cloud provision

metrics integration (tb and many to come)

collapsible Gitlab or wiki link
collapsible GH or wiki link
collapsible BB or wiki link

reports

collapsible Gitlab or wiki link
collapsible GH or wiki link
collapsible BB or wiki link

cloud provision

collapsible Gitlab or wiki link
collapsible GH or wiki link

Installation

env variables

Command Reference

@casperdcl casperdcl temporarily deployed to internal July 2, 2021 22:50 Inactive
@casperdcl casperdcl temporarily deployed to internal July 2, 2021 22:59 Inactive
@casperdcl casperdcl temporarily deployed to internal July 2, 2021 23:21 Inactive
@DavidGOrtega
Copy link
Contributor

Great! 🙏

@DavidGOrtega DavidGOrtega merged commit 9dc794e into master Jul 4, 2021
@DavidGOrtega DavidGOrtega deleted the readme-reupholster branch July 4, 2021 21:43
This was referenced Jul 11, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Markdown files p1-important High priority
Projects
None yet
Development

Successfully merging this pull request may close these issues.

overhaul README
4 participants