Skip to content

Commit

Permalink
Merge pull request #117 from gradle/refresh
Browse files Browse the repository at this point in the history
Reference the EAP on the Declarative Gradle site
  • Loading branch information
oleg-nenashev committed Aug 30, 2024
2 parents 4d979ac + 0b0046c commit 56e1a7a
Show file tree
Hide file tree
Showing 12 changed files with 239 additions and 19 deletions.
32 changes: 25 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,27 @@ We are working on _Declarative Gradle_ to realize that part of the vision.
This is an experimental project, stay tuned for updates!

Learn more in the [Declarative Gradle Announcement](https://blog.gradle.org/declarative-gradle)
blog post and [other publications](./publications/README.md).
blog post and [other publications](./docs/publications/README.md).

!!! info
_Declarative Gradle_ is an **experimental** project.
Currently, no compatibility is guaranteed, and there is no commitment to the DSL syntax
and available features.
## Status

Learn how you can contribute in the [Participate](./docs/CONTRIBUTING.md) section.
_Declarative Gradle_ is an **experimental** project, now in [Early Access Preview (EAP)](./docs/EAP.md).
We invite you to [try out Declarative Gradle](./docs/getting-started/README.md),
and to [share feedback](./docs/feedback.md).
The project includes the following experimental parts:

- Changes in Gradle to support DCL files
- Changes in Android Studio to support DCL files
- Prototype plugins demonstrating software types and higher-level models
- A Gradle test client demonstrating features not yet implemented in the IDE

Currently, no compatibility is guaranteed, and there is no commitment to the DSL syntax
and available features.
Learn how you can contribute in the [Participate](./docs/CONTRIBUTING.md) section.

<a class="button button--blue" href="./docs/feedback">
Share Your Feedback
</a>

## Key Principles

Expand Down Expand Up @@ -64,4 +77,9 @@ The _Declarative Gradle_ experiment is still in an early stage but is ready for
* [Getting Started](docs/getting-started/README.md) - Learn how to try _Declarative Gradle_ yourself.
* [Documentation](docs/reference/README.md) - Learn about the fundamentals behind _Declarative Gradle_.
* [Participate](docs/CONTRIBUTING.md) - Learn how you can help shape the future of _Declarative Gradle_.
* [Resources](publications/README.md) - Learn more from conferences, interviews, articles, etc.
* [Resources](docs/publications/README.md) - Learn more from conferences, interviews, articles, etc.

## Share Feedback

We invite you to [try out Declarative Gradle](./docs/getting-started/README.md),
and to [share your feedback](./docs/feedback.md).
3 changes: 2 additions & 1 deletion docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,9 @@ Discussion and sharing feedback is the recommended way of participation at the m
## Share Feedback

While the project is in early stages,
initial feedback on DSL and use-cases will be appreciated!
initial feedback on the DSL, early demos, features and use-cases will be appreciated!

- Fill out the [Feedback Form](./feedback.md)
- `#declarative-gradle` channel on the [Gradle Community Slack](https://gradle.org/slack-invite)

## Adopting Declarative Gradle in your projects
Expand Down
6 changes: 6 additions & 0 deletions docs/EAP.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Declarative Gradle - Early Access Preview

!!! info

In July 2024, we announced the first early access preview (EAP) of Declarative Gradle.
See this [blogpost](https://blog.gradle.org/declarative-gradle-first-eap) for the current status.
121 changes: 121 additions & 0 deletions docs/assets/css/gradle.css
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,17 @@
--md-primary-fg-color--dark: var(--gradle-bg-dark);
}

.md-banner {
div {
font-size: large;
text-align: center;
a {
color: var(--gradle-blue);
font-weight: bold;
}
}
}

.md-content {
--md-typeset-a-color: var(--gradle-blue-lite);
}
Expand Down Expand Up @@ -48,3 +59,113 @@ h4 {
.md-typeset details {
font-size: 16px
}

.youtube-video {
overflow: hidden;
position: relative;
display: flex;
justify-content: center;

div {
position: relative;
height: 100%;
width: 100%;
aspect-ratio: 16/9;
max-width: 900px;
}

iframe {
position: absolute;
top: 0;
left: 0;
width: 100%;
height: 100%;
}
}

.grid-container {
display: flex;
flex-wrap: wrap;
margin-left: auto;
margin-right: auto;
gap: 1rem;
vertical-align: middle;

.card {
display: block;
border: .2rem solid;
border-radius: 1rem;
padding: 1rem;
align-items: center;
width: 48%;
min-width: 320px;

h3 {
font-size: x-large;
font-weight: bolder;
span {
margin-right: 0.5rem;
.section-icon {
width: 20px;
height: 20px;
}
}
}

items {
font-size: larger;
font-weight: bold;
}
}
}

.button {
display: inline-block;
min-width: 180px;
padding: 10px 20px;
font-size: 17px;
line-height: 1.4;
text-align: center;
font-size: large;
font-weight: bold;
white-space: nowrap;
cursor: pointer;
border-style: solid;
border-width: 1px;
border-radius: 8px;
transition: background-color .3s ease, border .3s ease;
}

.icon {
width: 20px;
}

.button--blue,
.button--blue-lite {
color: white;
border-color: transparent;
&:hover {
color: white;
}
}


.button--blue {
border-color: var(--gradle-blue-lite);
background: var(--gradle-blue);
background: linear-gradient(var(--button-gradient-angle), var(--gradle-blue) 0%, var(--gradle-blue-lite) 100%);
transition: none;
&:hover {
background-color: var(--gradle-blue-lite);
color: white;
}
}


.button--blue-lite {
background-color: var(--gradle-bg-gray);
&:hover {
background-color: var(--gradle-blue-lite);
color: white;
}
}
15 changes: 15 additions & 0 deletions docs/assets/js/google-tag-support.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
// Support for DPE University follow ups
document.addEventListener("DOMContentLoaded", (event) => {
var links = document.getElementsByTagName("a");
for (let i = 0; i < links.length; i++) {
var link = links[i]
if(link.getAttribute("href")?.startsWith("https://dpeuniversity.gradle.com/")) {
link.setAttribute("promo", "yes")
link.setAttribute("promo_offer", "DPEU")
link.setAttribute("promo_type", link.getElementsByTagName("a") ? "link" : "image")
if (!link.getAttribute("promo_location")) {
link.setAttribute("promo_location", "declarative-gradle-site")
}
}
}
});
16 changes: 16 additions & 0 deletions docs/feedback.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Declarative Gradle - Share Feedback

While Declarative Gradle is in early stages, you can explore the project samples and some of the features.
Check out the [Getting Started Guide](./getting-started/README.md) tfor the pointer.
Initial feedback on the DSL, early demos, features and use-cases will be appreciated!

## Feedback Form

If the form below does not load,
use [this link](https://docs.google.com/forms/d/e/1FAIpQLSdA8uHyZYSIAlzgg-Hxj60_Qv5LgvNKr01NDAiv4ZoxpX5YRA/viewform)

<iframe src="https://docs.google.com/forms/d/e/1FAIpQLSdA8uHyZYSIAlzgg-Hxj60_Qv5LgvNKr01NDAiv4ZoxpX5YRA/viewform?embedded=true" width="100%" height="2345" frameborder="0" marginheight="0" marginwidth="0">Loading…</iframe>

## Other Feedback Channels

- `#declarative-gradle` channel on the [Gradle Community Slack](https://gradle.org/slack-invite)
3 changes: 3 additions & 0 deletions docs/getting-started/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
In our first [announcement](https://blog.gradle.org/declarative-gradle), we introduced our ideas for an experimental project we called Declarative Gradle.

Since then, we've been working hard on several fronts to create the first early access preview (EAP) for Declarative Gradle.
In July 2024, we [announced the Early Access Preview (EAP)](./../EAP.md) of Declarative Gradle.
As part of this preview, we published several project samples that are ready for feedback.
These include Java, Kotlin, and Android application samples and a port of the popular Now in Android application.

!!! info
With the first EAP, we would like you to try out what we have built so far.
Expand Down
File renamed without changes.
16 changes: 12 additions & 4 deletions publications/README.md → docs/publications/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
# Declarative Gradle. Publications

## Articles

- [Early Access Preview (EAP) Announcement](./../EAP.md) by Sterling Greene - July 2024
- [Project Announcement](https://blog.gradle.org/declarative-gradle) by Piotr Jagielski - November 2023 - Initial project announcement and the manifesto
- [Declarative Gradle? Amper? What’s going on?!](https://github.com/kotlin-magazine/kotlin-magazine/blob/main/articles/siggi_gunnarsson_declarative_builds_for_kotlin.md) by Siggi Gunnarsson, May 2024, [fun code() magazine](https://github.com/kotlin-magazine/kotlin-magazine)

## News

We publish monthly updates on Declarative Gradle as a part of the
[Gradle Build Tool Newslettter](https://newsletter.gradle.org/).
Make sure to subscribe!

## Conference Presentations

- [KotlinConf 2024 - Developer-first Gradle builds](./2024-05-kotlinconf.md) by Sterling Greene and Paul Merlin
Expand All @@ -9,9 +21,5 @@
- [Declarative Gradle and Gradle History Gradle](https://youtu.be/xZRR71VtmGc?si=aIFWvKL80S97s_el) with Adam Murdoch, CTO at - May 02, 2024
- [Declarative Gradle - Build Propulsion Lab](https://www.youtube.com/watch?v=TF_EuVeLND0) with Paul Merlin - April 2024, Devoxx France

## Articles

- [Declarative Gradle
](https://blog.gradle.org/declarative-gradle) by Piotr Jagielski - November 2023 - Initial project announcement and the manifesto
- [Declarative Gradle? Amper? What’s going on?!](https://github.com/kotlin-magazine/kotlin-magazine/blob/main/articles/siggi_gunnarsson_declarative_builds_for_kotlin.md) by Siggi Gunnarsson, May 2024, [fun code() magazine](https://github.com/kotlin-magazine/kotlin-magazine)

16 changes: 16 additions & 0 deletions docs/theme/main.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{% extends "base.html" %}

{% block announce %}
Declarative Gradle is now in Early Access Preview (EAP), and we need your feedback!
<a href="https://declarative.gradle.org/docs/getting-started/">Try it out</a>
and <a href="https://declarative.gradle.org/docs/feedback/">share your experiences</a>.
{% endblock %}

{% block scripts %}
{{ super() }}

<!-- Google Tag Manager (noscript) -->
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-WRTQKGT"
height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<!-- End Google Tag Manager (noscript) -->
{% endblock %}
8 changes: 8 additions & 0 deletions docs/theme/partials/integrations/analytics/custom.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<!-- Google Tag Manager -->
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
})(window,document,'script','dataLayer','GTM-WRTQKGT');
</script>
<!-- End Google Tag Manager -->
22 changes: 15 additions & 7 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ site_dir: _site
# Theme
theme:
name: material
custom_dir: docs/theme/
highlightjs: true
features:
- announce.dismiss
Expand Down Expand Up @@ -92,14 +93,17 @@ nav:
- Overview: docs/reference/README.md
- Roadmap: docs/ROADMAP.md
- Software Features: docs/reference/software-features.md
- Participate:
- Resources:
- Publications: docs/publications/README.md
- Contributing: docs/CONTRIBUTING.md
- Feedback Form: docs/feedback.md
- Code of Conduct: docs/CODE_OF_CONDUCT.md
- Resources:
- Publications: publications/README.md
- Share Feedback: docs/feedback.md

extra_css:
- docs/assets/css/gradle.css
extra_javascript:
- docs/assets/js/google-tag-support.js

extra:
social:
Expand All @@ -118,17 +122,19 @@ extra:
- icon: fontawesome/brands/mastodon
link: https://mastodon.social/@Gradle
name: Mastodon
# analytics:
# provider: google
# property: TODO
analytics:
provider: custom

plugins:
- search
- autorefs
# FIXME: Collision on GitHub Actions, to be fixed later
# - macros
- mkdocs-pdf
- social
- social:
cards_layout_options:
background_color: "#010002"
font_family: Lato
- same-dir
- include-markdown
- redirects:
Expand All @@ -138,6 +144,8 @@ plugins:
'docs/kotlin/README.md': 'docs/getting-started/samples.md#kotlin-application'
'docs/swift/README.md': 'docs/getting-started/samples.md#swift'
'unified-prototype/README.md': 'docs/getting-started/samples.md#prototypes'
'docs/EAP.md': https://blog.gradle.org/declarative-gradle-first-eap
'publications/README.md': docs/publications/README.md

# Markdown
markdown_extensions:
Expand Down

0 comments on commit 56e1a7a

Please sign in to comment.