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

docs: Document Yarn support in cachi2 #425

Merged
merged 1 commit into from
Jan 4, 2024

Conversation

eskultety
Copy link
Member

@eskultety eskultety commented Dec 14, 2023

Maintainers will complete the following section

  • Commit messages are descriptive enough
  • [n/a] Code coverage from testing does not decrease and new code is covered
  • Docs updated (if applicable)
  • Docs links in the code are still valid (if docs were updated)

Note: if the contribution is external (not from an organization member), the CI
pipeline will not run automatically. After verifying that the CI is safe to run:

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@brunoapimentel
Copy link
Contributor

I think we also want to have a complete example, following what has been done on other package managers: https://github.com/containerbuildsystem/cachi2/blob/main/docs/usage.md#usage-examples.

I'm ok if this is done in a follow-up PR, though.

@eskultety
Copy link
Member Author

I think we also want to have a complete example, following what has been done on other package managers: https://github.com/containerbuildsystem/cachi2/blob/main/docs/usage.md#usage-examples.

I'm ok if this is done in a follow-up PR, though.

Nope, that's a good point which needs to be addressed in this PR.

@eskultety eskultety force-pushed the yarn-docs branch 2 times, most recently from 409d2ac to 88fb525 Compare December 15, 2023 07:24
@eskultety
Copy link
Member Author

I think we also want to have a complete example, following what has been done on other package managers: https://github.com/containerbuildsystem/cachi2/blob/main/docs/usage.md#usage-examples.

Added the change, however, @brunoapimentel I'd like to ask you to move your sample-nodejs-app Yarn modifications to the main cachito nodejs repo which my docs changes refer to. Also, I think you'll need to do a few cosmetic changes there so that the docs matches is, e.g. the Dockerfile.

@eskultety
Copy link
Member Author

Marking this as a draft since the docs contains information and steps that assume Yarn to be enabled which it's not yet. This PR can still be reviewed in the meantime though, we should only postpone its merging until the very last moments before releasing support for Yarn v3.

README.md Outdated Show resolved Hide resolved
docs/yarn.md Outdated Show resolved Hide resolved
docs/yarn.md Outdated Show resolved Hide resolved
docs/yarn.md Outdated Show resolved Hide resolved
@brunoapimentel
Copy link
Contributor

I think we also want to have a complete example, following what has been done on other package managers: https://github.com/containerbuildsystem/cachi2/blob/main/docs/usage.md#usage-examples.

Added the change, however, @brunoapimentel I'd like to ask you to move your sample-nodejs-app Yarn modifications to the main cachito nodejs repo which my docs changes refer to. Also, I think you'll need to do a few cosmetic changes there so that the docs matches is, e.g. the Dockerfile.

👍 #425 (comment)

docs/yarn.md Outdated Show resolved Hide resolved
docs/yarn.md Outdated Show resolved Hide resolved
@eskultety
Copy link
Member Author

Depends on #440

@eskultety eskultety force-pushed the yarn-docs branch 2 times, most recently from 18b64da to 6adc314 Compare January 4, 2024 11:34
@eskultety eskultety marked this pull request as ready for review January 4, 2024 11:35
Copy link
Contributor

@brunoapimentel brunoapimentel left a comment

Choose a reason for hiding this comment

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

LGTM 🚀

STONEBLD-1691

Signed-off-by: Erik Skultety <[email protected]>
@eskultety eskultety added this pull request to the merge queue Jan 4, 2024
Merged via the queue into containerbuildsystem:main with commit 714a6a7 Jan 4, 2024
15 checks passed
@eskultety eskultety deleted the yarn-docs branch January 4, 2024 18:12
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.

3 participants