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

Getting Started with Declarative Gradle and Subsite #63

Merged
merged 9 commits into from
May 20, 2024
Merged

Conversation

oleg-nenashev
Copy link
Member

This is a bulk change that improves the documentation:

  • Add Getting Started guide by leveraging First readme for android #62 from @lkasso and the prototypes
  • Add ROADMAP.md with an overview of the key milestones
  • Update README with new references
  • Create an experimental MkDocs + Material for MkDocs subsite for evaluation. We are not using Material for MkDocs sub-projects at the moment, so we cannot reuse this file on gradle.org right away
  • Update the contributing guidelines to reflect the current stage

For #42 #45 #44

@oleg-nenashev oleg-nenashev added the documentation Improvements or additions to documentation label May 20, 2024
README.md Outdated Show resolved Hide resolved
ROADMAP.md Outdated Show resolved Hide resolved
ROADMAP.md Outdated Show resolved Hide resolved
ROADMAP.md Outdated Show resolved Hide resolved
ROADMAP.md Outdated Show resolved Hide resolved

Scope: Declarative Gradle can be evaluated with limited functionality and with support from the team.
This includes:
the alpha release of the Declarative Gradle plugins,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💭 bulleted list here?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would not do that, unless we can reference items

ROADMAP.md Outdated Show resolved Hide resolved
@@ -56,7 +56,8 @@ Converted subprojects:

Let’s take a look at a `build.gradle.dcl` file which replaces the common `build.gradle` or `build.gradle.kts` files:

core/common/build.gradle.dcl
_core/common/build.gradle.dcl_
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❗ The example below this can be updated to remove the entire buildTypes block, it no longer needs to be explicit.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's do in a follow-uo


## Installing Components

- You will need the latest [Gradle Build Tool nightly build](https://gradle.org/nightly/).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤔 I would make this disclaimer even more prominent. I try to keep the wrapper up-to-date, but sometimes miss it or it isn't immediately possible (waiting on reviews). I'd make this a callout and note that running this project frequently requires bleeding edge features and experiments only available in the nightly, and that you might have to manually download it, etc.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed, but I do not think it should be in getting started, which is a read-once thing. I would add it to the generic user guide if you're fine with that

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#65 for the follow-up

@tresat
Copy link
Member

tresat commented May 20, 2024

One more comment - the Declarative Gradle roadmap timeline goes from right -> left as time increases, whereas the main Gradle roadmap goes from left -> right. Shouldn't these use the same direction?

Copy link
Member

@lkasso lkasso left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 on Tom's comments.

ROADMAP.md Outdated Show resolved Hide resolved
Co-authored-by: Laura Kassovic <[email protected]>
Co-authored-by: Tom Tresansky <[email protected]>
ROADMAP.md Outdated Show resolved Hide resolved
@oleg-nenashev
Copy link
Member Author

One more comment - the Declarative Gradle roadmap timeline goes from right -> left as time increases, whereas the main Gradle roadmap goes from left -> right. Shouldn't these use the same direction?

Subject to discuss with @pioterj who reordered the main roadmap :)
I find the current order more natural for users because what's coming soon and ready is close on the left, and the future is to the right. I know that Kanban is built differently

@oleg-nenashev oleg-nenashev merged commit 4f04e78 into main May 20, 2024
1 check passed
@oleg-nenashev oleg-nenashev deleted the subsite branch May 20, 2024 19:06
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants