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

document new subcommands #324

Merged
merged 13 commits into from
Sep 22, 2022
Merged

document new subcommands #324

merged 13 commits into from
Sep 22, 2022

Conversation

casperdcl
Copy link
Contributor

@casperdcl casperdcl commented Sep 13, 2022

@casperdcl casperdcl added documentation Markdown files enhancement New feature or request p1-important High priority C: ref Content of /doc/*-reference C: start Content of /doc/start labels Sep 13, 2022
@casperdcl casperdcl requested a review from 0x2b3bfa0 September 13, 2022 12:54
@casperdcl casperdcl self-assigned this Sep 13, 2022
@shcheklein shcheklein temporarily deployed to cml-dev-command-renamin-jvm3vc September 13, 2022 12:55 Inactive
@github-actions
Copy link

github-actions bot commented Sep 13, 2022

65f54f8

Link Check Report

There were no links to check!

CML watermark

content/docs/ref/pr.md Outdated Show resolved Hide resolved
@0x2b3bfa0
Copy link
Member

@casperdcl, now you can document iterative/cml#1166

Copy link
Contributor

@tasdomas tasdomas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few comments.

Post a Markdown report as a comment on a commit or pull/merge request.
## update

Update the last CML comment instead of creating a new one. If no previous
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/last CML comment/last comment created using CML ?

content/docs/ref/comment.md Outdated Show resolved Hide resolved
@@ -4,7 +4,8 @@
cml publish [options] <image file>
```

Publicly host an image for displaying in a CML report.
Publicly host an image for displaying in a CML report. Used internally by
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this needs to be updated.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What needs updating?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't we include a reference to minroud here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah, this page is hidden atm so not really worth updating IMO (removed from sidebar & not part of official API anymore, hence the "used internally" note here). I've only left it in just in case people still have an old bookmark.

content/docs/ref/publish.md Show resolved Hide resolved
Co-authored-by: Domas Monkus <[email protected]>
@shcheklein shcheklein temporarily deployed to cml-dev-command-renamin-jvm3vc September 15, 2022 00:15 Inactive
@dacbd
Copy link
Contributor

dacbd commented Sep 15, 2022 via email

@shcheklein shcheklein temporarily deployed to cml-dev-command-renamin-jvm3vc September 22, 2022 11:59 Inactive
@casperdcl casperdcl merged commit 65f54f8 into master Sep 22, 2022
@casperdcl casperdcl deleted the command-renaming branch September 22, 2022 12:00
@casperdcl casperdcl added epic Collection of sub-issues and removed epic Collection of sub-issues labels Oct 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C: ref Content of /doc/*-reference C: start Content of /doc/start documentation Markdown files enhancement New feature or request p1-important High priority
Projects
None yet
5 participants