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

Glues - Better way to doc glues without replication #111

Open
dalssoft opened this issue Feb 14, 2022 · 2 comments
Open

Glues - Better way to doc glues without replication #111

dalssoft opened this issue Feb 14, 2022 · 2 comments
Assignees
Labels
enhancement New feature or request hacktoberfest severity-major Item is very important

Comments

@dalssoft
Copy link
Member

Currently it is hard to keep both herbsjs.github.io repo and glues repos in sync regarding doc.

Improving a glue implies in:
1 - Issue to the improvement X
2 - PR with the improvement X + doc X on readme.md
3 - Issue to doc X on herbsjs.github.io
4 - PR to doc X on herbsjs.github.io

Suggestion:
Have a way to read docs direct from glue repos and compose it on herbsjs.github.io repo to make step 3 e 4 unnecessary:

1 - Issue to the improvement X
2 - PR with the improvement X + doc X on ./doc folder
3 - rebuild herbsjs.github.io using docs from the glue

It would need a CI/CD magic (no idea how), but it would simplify a lot the current workflow.

@dalssoft dalssoft added the enhancement New feature or request label Feb 14, 2022
@italojs italojs added the severity-major Item is very important label May 4, 2022
@italojs
Copy link
Member

italojs commented May 4, 2022

i agree

@judibo
Copy link
Contributor

judibo commented Jul 26, 2022

I´m trying to find a solution for this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request hacktoberfest severity-major Item is very important
Projects
Status: More discussion is needed
Development

No branches or pull requests

3 participants