Codeberg/Documentation
42
199
Fork
You've already forked Documentation
161

Mentioning codeberg-cli tool #285

Merged
fnetX merged 3 commits from RobWalt/Documentation:feat/codeberg-cli into main 2023年02月24日 21:14:29 +01:00
Contributor
Copy link

Hi everyone,

I'm working on a CLI tool for codeberg. I thought it might be helpful to include a note about that in the documentation.

Let me know what you think about it!

Hi everyone, I'm working on a CLI tool for codeberg. I thought it might be helpful to include a note about that in the documentation. Let me know what you think about it!
Owner
Copy link

How far is the progress?

Are you aware of the tea cli for Gitea/Forgejo? Can you elaborate on the differences?

I think if the tool is rather WIP, we should instead advertise it on socialmedia and call for participation and feedback, but I'm also fine to list it as an option.

How far is the progress? Are you aware of the `tea` cli for Gitea/Forgejo? Can you elaborate on the differences? I think if the tool is rather WIP, we should instead advertise it on socialmedia and call for participation and feedback, but I'm also fine to list it as an option.
Author
Contributor
Copy link

Are you aware of the tea cli for Gitea/Forgejo? Can you elaborate on the differences?

Yeah, I'm aware of it. cod is supposed to be a codeberg tailored version of tea. There are not many differences between the tools yet. The main ones are:

  • cod is written in rust, which implies better safety guarantees compared to go which is used for tea (sorry for shilling rust)
  • as far as I'm aware there is no option to edit issues, prs, etc. with tea through the command line. cod already offers that feature
  • the cod ui looks a bit cleaner, but that might be my personal opinion

How far is the progress?

The important core commands are implemented: creating/listing/editing issues/prs. So with this it is already kind of useful imo. I'll continue to add more options to it bit by bit going forward.


I think if the tool is rather WIP, we should instead advertise it on socialmedia and call for participation and feedback, but I'm also fine to list it as an option.

At the moment I'm making good feature progress on my own. Help is always appreciated though.

> Are you aware of the tea cli for Gitea/Forgejo? Can you elaborate on the differences? Yeah, I'm aware of it. `cod` is supposed to be a codeberg tailored version of `tea`. There are not many differences between the tools yet. The main ones are: - `cod` is written in rust, which implies better safety guarantees compared to go which is used for `tea` (sorry for shilling rust) - as far as I'm aware there is no option to edit issues, prs, etc. with `tea` through the command line. `cod` already offers that feature - the `cod` ui looks a bit cleaner, but that might be my personal opinion --- > How far is the progress? The important core commands are implemented: creating/listing/editing issues/prs. So with this it is already kind of useful imo. I'll continue to add more options to it bit by bit going forward. --- > I think if the tool is rather WIP, we should instead advertise it on socialmedia and call for participation and feedback, but I'm also fine to list it as an option. At the moment I'm making good feature progress on my own. Help is always appreciated though.
Owner
Copy link

Do you mind making the section a little more generic, and mentioning both tea and cod, maybe even outlining the differences?

Thank you for working on cod! Good luck.

Do you mind making the section a little more generic, and mentioning both tea and cod, maybe even outlining the differences? Thank you for working on cod! Good luck.
Author
Contributor
Copy link

Sure! I'm going to work on general documentation this week anyways so this fits nicely in the plans 👍

Thanks for the shoutout btw! The appreciation made me happy 😊

Sure! I'm going to work on general documentation this week anyways so this fits nicely in the plans :+1: Thanks for the shoutout btw! The appreciation made me happy 😊
Author
Contributor
Copy link

I iterated a bit on my formulation but I'm still not sure if it is what you were imagining

I iterated a bit on my formulation but I'm still not sure if it is what you were imagining
fnetX left a comment
Copy link

Sounds a little biased, but otherwise looks good to me.

Happy to merge.

Sounds a little biased, but otherwise looks good to me. Happy to merge.
@ -95,0 +106,4 @@
The [codeberg-cli project](https://codeberg.org/RobWalt/codeberg-cli), aka. `cod`, is a CLI tool that's tailored for the use with Codeberg. The main difference compared to `tea` are:
- extra features: even in its early stages, `cod` provides some features that `tea` doesn't implement, like editing issues or pull requests
- rust-based: `cod` is written in rust, which has stronger safety guarantees than go which is used for `tea`
Owner
Copy link

Rust, Go - should be uppercase IMHO

Rust, Go - should be uppercase IMHO
Author
Contributor
Copy link

Changed that. Also adjusted the wording to sound less biased (hopefully)

Changed that. Also adjusted the wording to sound less biased (hopefully)
Owner
Copy link

there were two mentions of Rust in that line 😛

there were two mentions of Rust in that line 😛
Author
Contributor
Copy link

fixed that commit to include all the rust occurences 🙈

*edit

Thanks for catching that!

fixed that commit to include all the rust occurences 🙈 *edit Thanks for catching that!
RobWalt force-pushed feat/codeberg-cli from 775f8ad699 to 91ba9ba876 2023年02月24日 21:12:33 +01:00 Compare
Owner
Copy link

Thank you. Sorry for the delay. Should be live soon :)

Thank you. Sorry for the delay. Should be live soon :)
@ -6,6 +6,8 @@ eleventyNavigation:
order: 20
---
# Git workflow
Owner
Copy link

Hi @RobWalt, could you provide a following patch that changes these headings (also for CLI) to h2 (###)?

It looks a little weird at https://docs.codeberg.org/git/clone-commit-via-cli/

Hi @RobWalt, could you provide a following patch that changes these headings (also for CLI) to h2 (`#` → `##`)? It looks a little weird at https://docs.codeberg.org/git/clone-commit-via-cli/
Owner
Copy link

Eventually the other headings need to become h3 then ...

Eventually the other headings need to become h3 then ...
Sign in to join this conversation.
No reviewers
Labels
Clear labels
Codeberg Pages
Issues affecting Codeberg Pages
Documentation Usability
Issues related to using and reading docs.codeberg.org
Forgejo
Good First Issue! 👋
Kind: Bug
Kind: Documentation
Kind: Enhancement
Kind: Feature
Kind: Question
Kind: Security
Licensing
Part: Generator
This is related to the generation of the documentation, not to the content itself
Priority: High
The priority is high
Priority: Low
The priority is low
Priority: Medium
The priority is medium
Reviewed: Confirmed
Something has been confirmed
Reviewed: Duplicate
Something exists already
Reviewed: Invalid
Something was marked as invalid
Reviewed: Wontfix
Something won't be fixed
Status: Blocked
Status: Help wanted
Contributions are welcome!
Status: In progress
Work is in progress
Status: Needs feedback
Feedback is needed
Status: Ready for Review
Work is completed
Status: Review
Review is in progress / Reviewers wanted
Status: Stale
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
Codeberg/Documentation!285
Reference in a new issue
Codeberg/Documentation
No description provided.
Delete branch "RobWalt/Documentation:feat/codeberg-cli"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?