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

Review Migration Guide for language and consistency #182

Closed
rkratky opened this issue Oct 15, 2020 · 9 comments
Closed

Review Migration Guide for language and consistency #182

rkratky opened this issue Oct 15, 2020 · 9 comments
Labels
area/documentation Improvements or additions to documentation kind/enhancement New feature or request lifecycle/rotten Rotten items. These items have been stale for 60 days and are now closed. lifecycle/stale Stale items. These items have not been updated for 90 days.

Comments

@rkratky
Copy link
Collaborator

rkratky commented Oct 15, 2020

Is your feature request related to a problem? Please describe.

The Migration Guide (https://devfile.github.io/devfile/migration_guide.html) needs to be reviewed and updated to follow Red Hat documentation and style guide principles.

Describe the solution you'd like

The content is consistent with language and style principles used by upstream Red Hat documentation projects.

@elsony elsony added the area/documentation Improvements or additions to documentation label Oct 15, 2020
@rkratky rkratky added the kind/enhancement New feature or request label Oct 16, 2020
@rkratky
Copy link
Collaborator Author

rkratky commented Nov 26, 2020

@boczkowska, I'd say at least some of this has already been completed in devfile/docs#22, right? Could you please check if more is needed?

@yhontyk
Copy link

yhontyk commented Dec 1, 2020

@rkratky sure, I'll pick it up

@jc-berger
Copy link

This issue can be closed as I've done a language review of migrating-to-devfile-v2 and it looks good, and the PR's been merged.

@rkratky
Copy link
Collaborator Author

rkratky commented Dec 11, 2020

The content does not follow our style guide and still needs to be worked on. @jc-berger, which PR are you referring to?

@jc-berger
Copy link

jc-berger commented Dec 11, 2020

@rkratky, looking at PR #22: devfile/docs#22

And at migrating to devfile 2 which I believe is the PR's rendered version after the big doc restructure: https://docs.devfile.io/devfile/user-guide/migrating-to-devfile-v2.html

@rkratky
Copy link
Collaborator Author

rkratky commented Dec 11, 2020

@jc-berger, yes, I know about PR #22 -- that's why I commented above: "I'd say at least some of this has already been completed in devfile/docs#22, right? Could you please check if more is needed?"

A quick glance reveals that more work indeed is needed in https://docs.devfile.io/devfile/user-guide/migrating-to-devfile-v2.html

@jc-berger
Copy link

@rkratky, will review more next week, thanks.

@rkratky
Copy link
Collaborator Author

rkratky commented Jan 28, 2021

Copy link

github-actions bot commented Jul 9, 2024

This issue is stale because it has been open for 90 days with no activity. Remove stale label or comment or this will be closed in 60 days.

@github-actions github-actions bot added the lifecycle/stale Stale items. These items have not been updated for 90 days. label Jul 9, 2024
@github-actions github-actions bot added the lifecycle/rotten Rotten items. These items have been stale for 60 days and are now closed. label Sep 7, 2024
@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Sep 7, 2024
@github-project-automation github-project-automation bot moved this to Done ✅ in Devfile Project Sep 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation kind/enhancement New feature or request lifecycle/rotten Rotten items. These items have been stale for 60 days and are now closed. lifecycle/stale Stale items. These items have not been updated for 90 days.
Projects
Status: Done ✅
Development

Successfully merging a pull request may close this issue.

4 participants