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

adding hyperlinks for new section of artifacts faq #1627

Merged
merged 6 commits into from
Jan 19, 2024

Conversation

eggyhead
Copy link
Contributor

We now have FAQ docs on upload/artifact and download/artifact version compatibility and retention.

We want to hyperlink to these Question+Answers in the index section.

NOTE

If you have any edits to the updated sections, also please include those in this PR review!

@eggyhead eggyhead requested a review from a team as a code owner January 18, 2024 04:05
@bethanyj28
Copy link
Contributor

Maybe a bit nitpicky but

[actions/upload-artifact](https://github.com/actions/upload-artifact) and [actions/download-artifact](https://github.com/actions/download-artifact), are part of the [GitHub Actions toolkit](https://github.com/actions/toolkit) and are typically used together to upload and download artifacts in your workflows.

I don't think I'd classify upload-artifact or download-artifact as part of toolkit, but rather they leverage toolkit.

I'd also mention that only v4 has the same compatibility requirement. So maybe indicating something like this:

upload-artifact download-artifact toolkit
v4 v4 v2
<v3 <v3 < v1

Let me know what you think!

@eggyhead eggyhead requested a review from bethanyj28 January 18, 2024 17:39
Copy link
Contributor

@bethanyj28 bethanyj28 left a comment

Choose a reason for hiding this comment

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

Just one nit, looks great!

packages/artifact/docs/faq.md Outdated Show resolved Hide resolved
Consistent spacing in version table

Co-authored-by: Bethany <bethanyj28@users.noreply.github.com>
@eggyhead eggyhead merged commit 1fe633e into main Jan 19, 2024
2 checks passed
coolkiid pushed a commit to coolkiid/toolkit that referenced this pull request Dec 17, 2024
adding hyperlinks for new section of artifacts faq
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