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.

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

[Feature Request]: Improve documentation #53

Open
1 task done
Chrico opened this issue Jul 11, 2023 · 0 comments
Open
1 task done

[Feature Request]: Improve documentation #53

Chrico opened this issue Jul 11, 2023 · 0 comments
Assignees
@Chrico @tyrann0us
Labels
enhancement New feature or request

Comments

@Chrico
Copy link
Member

Chrico commented Jul 11, 2023

Is your feature request related to a problem?

Right now we have in many places repeating text, inputs or secrets like COMPOSER_AUTH_TOKEN, ENV_VARS, GITHUB_USER, ...

Describe the desired solution

We should move those "repeating global always available" inputs/secrets into a general documentation ( README.md ) maybe with a matrix (where is what used).

Additionaly we should improve the documentation to not have always "short desc, code block, table, advanced code block". The build-and-push-assets.yml workflow is actually a good example of having "more" documentation for the workflow itself https://github.com/inpsyde/reusable-workflows/blob/main/docs/build-and-push-assets.md

Describe the alternatives that you have considered

Additional context

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct
@Chrico Chrico added the enhancement New feature or request label Jul 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Chrico Chrico

@tyrann0us tyrann0us

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Chrico @tyrann0us