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

Revise repository documentation for devfiles #1131

Closed
6 tasks done
michael-valdron opened this issue Jun 12, 2023 · 5 comments
Closed
6 tasks done

Revise repository documentation for devfiles #1131

michael-valdron opened this issue Jun 12, 2023 · 5 comments
Assignees
@michael-valdron
Labels
area/documentation Improvements or additions to documentation area/releng Release engineering devtools-week kind/epic A high level requirement that can/should be split into smaller issues

Comments

@michael-valdron
Copy link
Member

michael-valdron commented Jun 12, 2023 •
edited
Loading

Which area/kind this issue is related to?

/area releng
/area documentation

Issue Description

A review and revising of all the documentation in devfile repositories, including READMEs. This includes adding missing instructions, updating outdated information and separation of documentation where it makes sense.

Acceptance Criteria
@michael-valdron michael-valdron self-assigned this Jun 12, 2023
@openshift-ci openshift-ci bot added area/releng Release engineering area/documentation Improvements or additions to documentation labels Jun 12, 2023
@michael-valdron michael-valdron moved this to Backlog in Devfile Project Jun 12, 2023
@michael-valdron michael-valdron moved this from Backlog to To Do 📝 in Devfile Project Jun 12, 2023
@kim-tsao kim-tsao moved this from To Do 📝 to Backlog in Devfile Project Jun 15, 2023
@michael-valdron michael-valdron mentioned this issue Jul 10, 2023
Merged
3 tasks
@michael-valdron
Copy link
Member Author

Partial revision of the index server README completed and ready for review: devfile/registry-support#176

@michael-valdron
Copy link
Member Author

This issue should be an epic, converting the acceptance criteria items into child issues with their owners and this item into an epic.

@michael-valdron
Copy link
Member Author

/kind epic

@openshift-ci openshift-ci bot added the kind/epic A high level requirement that can/should be split into smaller issues label Jul 11, 2023
@michael-valdron
Copy link
Member Author

This issue has been converted into an epic. Tracking will now be done by each component documentation task item.

@michael-valdron
Copy link
Member Author

All uncompleted issues are stale, closing this epic issue until there is priority.

@michael-valdron michael-valdron closed this as not planned Won't fix, can't repro, duplicate, stale Mar 5, 2024
@github-project-automation github-project-automation bot moved this from Backlog to Done ✅ in Devfile Project Mar 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@michael-valdron michael-valdron

Labels
area/documentation Improvements or additions to documentation area/releng Release engineering devtools-week kind/epic A high level requirement that can/should be split into smaller issues
Projects
Devfile Project
Status: Done ✅
Milestone
No milestone
Development

No branches or pull requests
1 participant
@michael-valdron