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

Improve documentation (provisioners, testsuite) #139

Closed
fabiobrz opened this issue Feb 2, 2024 · 2 comments
Closed

Improve documentation (provisioners, testsuite) #139

fabiobrz opened this issue Feb 2, 2024 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation nice-to-have

Comments

@fabiobrz
Copy link
Member

fabiobrz commented Feb 2, 2024

The provisioners documentation should quickly drive the user to selecting the right tool for their use, so e.g.: a simple table of available (grouped) provisioners per service/product, along with a one-liner usage hint, would help.

The testsuite documentation shuld explain the available profiles and deployments build options.

  • Environment: documentation
  • Steps to reproduce: N/A
@fabiobrz fabiobrz moved this to Todo in Intersmash library Feb 2, 2024
@fabiobrz fabiobrz added this to the IM2 - WIP milestone Feb 2, 2024
@fabiobrz fabiobrz added the documentation Improvements or additions to documentation label Feb 3, 2024
@rsearls rsearls self-assigned this Apr 1, 2024
@fabiobrz fabiobrz moved this from Todo to In Progress in Intersmash library Apr 10, 2024
@fabiobrz fabiobrz moved this from In Progress to Todo in Intersmash library Apr 29, 2024
@fabiobrz fabiobrz self-assigned this May 2, 2024
@fabiobrz fabiobrz moved this from Todo to In Progress in Intersmash library May 15, 2024
@dosubot dosubot bot added the stale Issue has not had recent activity or appears to be solved. Stale issues will be automatically closed label Sep 19, 2024
@dosubot dosubot bot closed this as not planned Won't fix, can't repro, duplicate, stale Oct 19, 2024
@dosubot dosubot bot removed the stale Issue has not had recent activity or appears to be solved. Stale issues will be automatically closed label Oct 19, 2024
@github-project-automation github-project-automation bot moved this from In Progress to Done in Intersmash library Oct 19, 2024
@fabiobrz fabiobrz reopened this Oct 19, 2024
Copy link

dosubot bot commented Jan 20, 2025

Hi, @fabiobrz. I'm Dosu, and I'm helping the intersmash team manage their backlog. I'm marking this issue as stale.

Issue Summary:

  • The issue suggests improvements to the documentation related to provisioners.
  • Proposes adding a table categorizing available provisioners by service or product with usage tips.
  • Recommends including detailed information on available profiles and deployment build options in the testsuite documentation.
  • No comments or activity have occurred since the issue was opened.

Next Steps:

  • Please let me know if this issue is still relevant to the latest version of the intersmash repository by commenting on the issue.
  • If there is no further activity, the issue will be automatically closed in 30 days.

Thank you for your understanding and contribution!

@dosubot dosubot bot added the stale Issue has not had recent activity or appears to be solved. Stale issues will be automatically closed label Jan 20, 2025
@fabiobrz fabiobrz moved this from Done to Todo in Intersmash library Jan 21, 2025
@fabiobrz fabiobrz removed the stale Issue has not had recent activity or appears to be solved. Stale issues will be automatically closed label Jan 21, 2025
@fabiobrz fabiobrz moved this from Todo to In Progress in Intersmash library Jan 21, 2025
@fabiobrz
Copy link
Member Author

This can now be closed as resolved, given the latest improvements to the the project documentation, and the final refinement in #224

@github-project-automation github-project-automation bot moved this from In Progress to Done in Intersmash library Jan 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation nice-to-have
Projects
Development

No branches or pull requests

2 participants