Skip to content

docs: update chisel how-to guides #679

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 5 commits into from
Aug 29, 2024
Merged

docs: update chisel how-to guides #679

merged 5 commits into from
Aug 29, 2024

Conversation

@linostar
Copy link
Contributor

@linostar linostar commented Aug 26, 2024 •
edited
Loading

  • Have you signed the CLA?

This update chisel how-to guides to include details such as the new command chisel find and chisel-releases' integrations tests for contributors.

@linostar linostar requested a review from a team August 26, 2024 07:39
@linostar linostar force-pushed the ROCKS-1433/update-chisel-howto-guides branch from ab530d5 to e2c0f2d Compare August 26, 2024 08:05
@linostar linostar changed the title docs: update chisel howto guides docs: update chisel how-to guides Aug 26, 2024
@linostar linostar force-pushed the ROCKS-1433/update-chisel-howto-guides branch from e2c0f2d to f586ee5 Compare August 26, 2024 08:44
@linostar linostar force-pushed the ROCKS-1433/update-chisel-howto-guides branch from f586ee5 to b3ac126 Compare August 26, 2024 10:27
lengau
lengau approved these changes Aug 26, 2024
View reviewed changes
Copy link
Collaborator

@lengau lengau left a comment

Choose a reason for hiding this comment

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

This is a good improvement. I do wonder though whether we should be considering where this whole document belongs compared to https://github.com/canonical/chisel-releases/blob/main/CONTRIBUTING.md

Specifically, this slicing how-to seems more about chisel than about Rockcraft. However, it also seems like chisel doesn't have an equivalent docs site that we could move this to.

@lengau lengau requested review from a team and tigarmo August 26, 2024 14:16
medubelko
medubelko requested changes Aug 26, 2024
View reviewed changes
@medubelko
Copy link
Contributor

medubelko commented Aug 26, 2024

I do wonder though whether we should be considering where this whole document belongs compared to https://github.com/canonical/chisel-releases/blob/main/CONTRIBUTING.md

Medium-term, I'd like all project contributor material to be in README and CONTRIBUTING, and platform/publishing/authoring material in the docs. Does that split make sense for how we've set up chisel?

As for documentation between microprojects, that will have to remain a longer-term concern.

cjdcordeiro
cjdcordeiro approved these changes Aug 27, 2024
View reviewed changes
@linostar linostar requested a review from medubelko August 28, 2024 12:05
@linostar
Copy link
Contributor Author

linostar commented Aug 29, 2024

@tigarmo This ready for merging. The failing spread tests are due to the problem in LXD waiting for a fix.

@tigarmo tigarmo merged commit 0865757 into main Aug 29, 2024
@tigarmo tigarmo deleted the ROCKS-1433/update-chisel-howto-guides branch August 29, 2024 18:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tigarmo tigarmo tigarmo approved these changes

@cjdcordeiro cjdcordeiro cjdcordeiro approved these changes

@lengau lengau lengau approved these changes

@medubelko medubelko medubelko approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@linostar @medubelko @tigarmo @cjdcordeiro @lengau