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

Add dedicated documentation section #34

Merged
merged 7 commits into from
Nov 30, 2023
Merged

Conversation

nanory
Copy link
Contributor

@nanory nanory commented Nov 30, 2023

What this PR does / why we need it:
Add a dedicated documentation section containing documentation like:

  • How the workflow works and how the parameters look like
  • What a developer needs to do in order to test the Garden Linux package build locally
  • How does the versioning works for Garden Linux packages.

Which issue(s) this PR fixes:
Fixes #5

@nanory nanory changed the title Feature/5 add documentation Add dedicated documentation section Nov 30, 2023
Copy link
Contributor

@alee-ntap alee-ntap 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. There are some more variables may add that after we stabilized extra needed inputs.

@nanory nanory force-pushed the feature/5-add-documentation branch from b9ebcac to 496933a Compare November 30, 2023 15:00
Copy link
Contributor

@Vincinator Vincinator 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 example how a documentation should look like.
Thanks!

Approved

@nanory nanory merged commit dd6577e into main Nov 30, 2023
4 checks passed
@nanory nanory deleted the feature/5-add-documentation branch November 30, 2023 15:02
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.

Replace pkg.yml with workflow variables
3 participants