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

Consolidate/link building OpenRewrite docs #238

Closed
mike-solomon opened this issue Oct 18, 2023 · 3 comments
Closed

Consolidate/link building OpenRewrite docs #238

mike-solomon opened this issue Oct 18, 2023 · 3 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@mike-solomon
Copy link
Contributor

mike-solomon commented Oct 18, 2023

As reported in our community Slack, we have a variety of docs that talk about how to build OpenRewrite. They're scattered around and contain different types of information.

We should go through these and determine:

  • Do we need each of those docs
  • How can these be connected
  • If there's any information that's wrong or missing
@mike-solomon mike-solomon added the enhancement New feature or request label Oct 18, 2023
@dawngerpony
Copy link
Contributor

Thanks for raising this issue!

At the very least it might be worth having a markdown file in each repository as well as the official docs site itself with a list of links to pages that help to solve the problem of "how to build this thing".

@timtebeek timtebeek moved this to Backlog in OpenRewrite Oct 19, 2023
@timtebeek timtebeek added the documentation Improvements or additions to documentation label Oct 19, 2023
@timtebeek
Copy link
Contributor

Even though I suggested we open an issue, I failed to remember I'd already opened such an issue previously;

Linking that here such that we can close both issues once we consolidate the docs. 😅

@mike-solomon
Copy link
Contributor Author

mike-solomon commented Nov 20, 2023

I:

I think this fixes the issues that were raised so I'll go ahead and close this. If you feel like I missed something or we should do more, please let me know ^_^

@github-project-automation github-project-automation bot moved this from Backlog to Done in OpenRewrite Nov 20, 2023
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 enhancement New feature or request
Projects
Archived in project
Development

No branches or pull requests

3 participants