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

Update README.md #199

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

Update README.md #199

wants to merge 2 commits into from

Conversation

yhontyk
Copy link

@yhontyk yhontyk commented Jan 28, 2025

Add overview of repositories to README to help contributors orient in the project setup.

  • Have you signed the CLA?

Add overview of repositories
Copy link
Member

@rebornplusplus rebornplusplus left a comment

Choose a reason for hiding this comment

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

Looks good to me, thank you!

Copy link
Collaborator

@letFunny letFunny left a comment

Choose a reason for hiding this comment

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

Thanks for taking the time to add this, just some minor comments about placement.

@rebornplusplus
Copy link
Member

The [build] job seems to fail because of an outdated action in use:

This request has been automatically failed because it uses a deprecated version of actions/upload-artifact: v3. Learn more: https://github.blog/changelog/2024-04-16-deprecation-notice-v3-of-the-artifact-actions/

Copy link
Collaborator

@letFunny letFunny left a comment

Choose a reason for hiding this comment

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

Thanks! Only a minor question.

Comment on lines +15 to +16
## How Chisel works

Copy link
Collaborator

Choose a reason for hiding this comment

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

Can we remove this, now that this is not part of the section with the repositories?

## Chisel repositories

- [chisel](https://github.com/canonical/chisel) - main repository of the project
- [chisel-docs](https://github.com/canonical/chisel-docs) - documentation repository
Copy link
Collaborator

Choose a reason for hiding this comment

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

Also, what is the scope of this PR in regards to adding a link to https://documentation.ubuntu.com/chisel/? Are we doing it later or somewhere else?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Y I'd do that later, once we have a version of the docs that covers everything (and more) from this README

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants