Skip to content
This repository has been archived by the owner on Oct 10, 2023. It is now read-only.

Separate usage guides between implementations #149

Closed
thepetk opened this issue Mar 20, 2023 · 3 comments · Fixed by #150
Closed

Separate usage guides between implementations #149

thepetk opened this issue Mar 20, 2023 · 3 comments · Fixed by #150
Assignees
Labels
area/documentation All issues related to documentation updates, corrections or bugs devtools_week Issue created on devtools week

Comments

@thepetk
Copy link
Collaborator

thepetk commented Mar 20, 2023

Which area this feature is related to?

/area documentation

Which area is this documentation change is related to?

Doc files inside the repository

Issue details

We should separate the documentation (usage guides) inside the repository to 3 different implementations:

Screenshot from 2023-03-20 11-46-43

As seen in the diagram, in the main Readme.md file, in the usage section, we should link the three guides (Java, Go, JS) . In each usage guide we can include:

  • Any building information needed (e.g for the CLIs)
  • Usage information
  • Output information

Target date: 3 Apr 2023

@thepetk thepetk added the area/documentation All issues related to documentation updates, corrections or bugs label Mar 20, 2023
@thepetk thepetk self-assigned this Mar 20, 2023
@openshift-ci
Copy link

openshift-ci bot commented Mar 20, 2023

@thepetk: The label(s) area/repository cannot be applied, because the repository doesn't have them.

In response to this:

Which area this feature is related to?

/area documentation

Which area is this documentation change is related to?

/area repository documentation

Issue details

We should separate the documentation (usage guides) inside the repository to 3 different implementations:

Screenshot from 2023-03-20 11-46-43

As seen in the diagram, in the main Readme.md file, in the usage section, we should link the three guides (Java, Go, JS) . In each usage guide we can include:

  • Any building information needed (e.g for the CLIs)
  • Usage information
  • Output information

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@jeffmaury
Copy link
Member

The JS and Java implementations are to be removed they are not up to date

@thepetk
Copy link
Collaborator Author

thepetk commented Mar 21, 2023

@jeffmaury I've added deprecation warnings inside the docs in order to be clear to everyone that those implementations are not up-to-date, till we remove them completely.

@thepetk thepetk added the devtools_week Issue created on devtools week label Mar 21, 2023
@thepetk thepetk moved this to Review in Progress in Sprint 234 Mar 21, 2023
@thepetk thepetk moved this from Review in Progress to Done in Sprint 234 Mar 29, 2023
@thepetk thepetk mentioned this issue Apr 19, 2023
14 tasks
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area/documentation All issues related to documentation updates, corrections or bugs devtools_week Issue created on devtools week
Projects
No open projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants