docs(main README): Fix broken README links, rearrange content for new users#7305
Merged
Conversation
…ent. Rearranges existing getting started section to reduce duplication and make it logical for new users to get started. Making it easier for new users to get started. Fixes apache#7304
Startrekzky
approved these changes
Apr 28, 2024
| Please see detailed instructions [here](https://devlake.apache.org/docs/Overview/Introduction#how-do-i-use-devlake), and ask the community if you get stuck at any point. | ||
| Install using either [Docker Compose](https://devlake.apache.org/docs/GettingStarted/DockerComposeSetup) or [Helm](https://devlake.apache.org/docs/GettingStarted/HelmSetup). | ||
|
|
||
| ### 2. Create a Blueprint |
Contributor
There was a problem hiding this comment.
Although you haven't touched this part, I think it needs to be updated to:
2. Create a DevLake project
Create a DevLake connection and add it to a DevLake project following this doc.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Make it easier for new users to get started by organizing resources for getting started on development.
Fixes #7304
Summary
This PR fixes a broken link in the main README for Developer resources. It also slightly rearranges the existing content to make more sense for new users of DevLake.
Does this close any open issues?
Closes issue #7304
No screenshots.
Other Information
Any other information that is important to this PR.