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

crane/gcrane: add pages #13853

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

rvandernoort
Copy link

@rvandernoort rvandernoort commented Sep 27, 2024

closes #13664

  • The page(s) are in the correct platform directories: common, linux, osx, windows, sunos, android, etc.
  • The page(s) have at most 8 examples.
  • The page description(s) have links to documentation or a homepage.
  • The page(s) follow the content guidelines.
  • The PR title conforms to the recommended templates.
  • Version of the command being documented (if known):
    • crane: v0.20.2
    • gcrane: v0.20.1

@CLAassistant
Copy link

CLAassistant commented Sep 27, 2024

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions bot added the new command Issues requesting creation of a new page. label Sep 27, 2024
@sebastiaanspeck sebastiaanspeck changed the title {{crane/gcrane}}: add documentation pages crane/gcrane: add pages Sep 27, 2024
pages/common/crane.md Outdated Show resolved Hide resolved
pages/common/crane.md Outdated Show resolved Hide resolved
pages/common/crane.md Outdated Show resolved Hide resolved
pages/common/crane.md Outdated Show resolved Hide resolved
pages/common/crane.md Outdated Show resolved Hide resolved
@sebastiaanspeck
Copy link
Member

#13808 also adds crane.md. I have added some suggestions to the crane.md in this PR since it is more detailed.

Copy link
Member

@sebastiaanspeck sebastiaanspeck left a comment

Choose a reason for hiding this comment

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

First of all, thank you for the amazing work you put into this! Always great to have a first-contributor on board.

I have reviewed upon crane-index-filter.md, but those comments also apply to the rest of the files.

pages/common/crane-append.md Outdated Show resolved Hide resolved
pages/common/crane-auth.md Outdated Show resolved Hide resolved
pages/common/crane-catalog.md Outdated Show resolved Hide resolved
pages/common/crane-copy.md Outdated Show resolved Hide resolved
pages/common/crane-digest.md Outdated Show resolved Hide resolved
pages/common/crane-export.md Outdated Show resolved Hide resolved
pages/common/crane-export.md Outdated Show resolved Hide resolved
pages/common/crane-flatten.md Outdated Show resolved Hide resolved
pages/common/crane-index-append.md Outdated Show resolved Hide resolved
pages/common/crane-index-filter.md Outdated Show resolved Hide resolved
@rvandernoort
Copy link
Author

Hi thanks for the extensive review. I'll implement your feedback after the weekend and then we can hopefully merge soon after! Cheers

@tldr-bot

This comment has been minimized.

1 similar comment
@tldr-bot

This comment has been minimized.

@rvandernoort
Copy link
Author

Hi I've updated the PR according to the guidelines and your feedback can you take another look? Furthermore, as the bot indicates I've added the various implementations of gcrane completion which has some OS specific commands, I hope I correctly implemented that aspect.

pages/common/crane-append.md Outdated Show resolved Hide resolved
pages/common/crane-registry.md Outdated Show resolved Hide resolved
pages/common/crane-tag.md Outdated Show resolved Hide resolved
pages/common/gcrane-copy.md Outdated Show resolved Hide resolved
pages/common/gcrane-help.md Outdated Show resolved Hide resolved
pages/common/gcrane.md Outdated Show resolved Hide resolved
@tldr-bot
Copy link

Hello! I've noticed something unusual when checking this PR:

  • The page pages/linux/gcrane-completion.md already exists in the common directory.
  • The page pages/osx/gcrane-completion.md already exists in the common directory.
  • The page pages/windows/gcrane-completion.md already exists in the common directory.

Is this intended? If so, just ignore this comment. Otherwise, please double-check the commits.

@tldr-bot
Copy link

Hello! I've noticed something unusual when checking this PR:

  • The page pages/linux/gcrane-completion.md already exists in the common directory.
  • The page pages/osx/gcrane-completion.md already exists in the common directory.
  • The page pages/windows/gcrane-completion.md already exists in the common directory.

Is this intended? If so, just ignore this comment. Otherwise, please double-check the commits.

1 similar comment
@tldr-bot
Copy link

Hello! I've noticed something unusual when checking this PR:

  • The page pages/linux/gcrane-completion.md already exists in the common directory.
  • The page pages/osx/gcrane-completion.md already exists in the common directory.
  • The page pages/windows/gcrane-completion.md already exists in the common directory.

Is this intended? If so, just ignore this comment. Otherwise, please double-check the commits.

Copy link
Member

@sebastiaanspeck sebastiaanspeck left a comment

Choose a reason for hiding this comment

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

Besides the extra comments, reviewing is easier if you do not force push the branch. That way we can see the changes per commit, especially if it is a large PR like this.

pages/common/crane.md Outdated Show resolved Hide resolved
pages/common/crane.md Outdated Show resolved Hide resolved
pages/common/crane.md Outdated Show resolved Hide resolved
pages/common/gcrane.md Outdated Show resolved Hide resolved
pages/common/gcrane-completion.md Outdated Show resolved Hide resolved
rvandernoort and others added 2 commits October 1, 2024 09:27
As we have OS specific implementation
Co-authored-by: Sebastiaan Speck <[email protected]>
@rvandernoort
Copy link
Author

Ah yes sorry, I though rebasing the branch with main was the way to go, but I get that this complicates the review. I've updated your last comments.

@sebastiaanspeck
Copy link
Member

Ah yes sorry, I though rebasing the branch with main was the way to go, but I get that this complicates the review. I've updated your last comments.

The easiest is a merge, which can also be performed from the PR-site itself:
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new command Issues requesting creation of a new page.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Page request: crane
4 participants