From 76ff70b2c23048da4c0248584208eb8672c9e5cf Mon Sep 17 00:00:00 2001 From: Oleg Nenashev Date: Fri, 9 Aug 2024 09:51:08 +0200 Subject: [PATCH 1/8] Initial blog engine --- .devcontainer/requirements.txt | 1 + blog/.authors.yml | 6 ++++ blog/images/icon/rss.svg | 4 +++ blog/index.md | 5 +++ blog/posts/2024-08-hello-world.md | 57 +++++++++++++++++++++++++++++++ mkdocs.yml | 13 +++++++ overrides/main.html | 7 ++++ 7 files changed, 93 insertions(+) create mode 100644 blog/.authors.yml create mode 100644 blog/images/icon/rss.svg create mode 100644 blog/index.md create mode 100644 blog/posts/2024-08-hello-world.md create mode 100644 overrides/main.html diff --git a/.devcontainer/requirements.txt b/.devcontainer/requirements.txt index d764670..7c69747 100644 --- a/.devcontainer/requirements.txt +++ b/.devcontainer/requirements.txt @@ -11,6 +11,7 @@ mkdocs-multirepo-plugin==0.6.3 mkdocs-redirects==1.2.1 mkdocs-extra-sass-plugin==0.1.0 mkdocs-render-swagger-plugin==0.1.1 +mkdocs-rss-plugin-1.15.0 mkdocs-same-dir==0.1.3 mkdocs-pdf==0.1.1 livereload==2.6.3 diff --git a/blog/.authors.yml b/blog/.authors.yml new file mode 100644 index 0000000..ab46dd9 --- /dev/null +++ b/blog/.authors.yml @@ -0,0 +1,6 @@ +authors: + gradleup: + name: GradleUp Team + description: > + GradleUp organizing team + avatar: https://github.com/gradleup.png diff --git a/blog/images/icon/rss.svg b/blog/images/icon/rss.svg new file mode 100644 index 0000000..7531837 --- /dev/null +++ b/blog/images/icon/rss.svg @@ -0,0 +1,4 @@ + + + + diff --git a/blog/index.md b/blog/index.md new file mode 100644 index 0000000..af17fbd --- /dev/null +++ b/blog/index.md @@ -0,0 +1,5 @@ +# GradleUp Blog + +[RSS feed of created content]({{ config.site_url }}feed_rss_created.xml) +[RSS feed of updated content]({{ config.site_url }}feed_rss_updated.xml) + diff --git a/blog/posts/2024-08-hello-world.md b/blog/posts/2024-08-hello-world.md new file mode 100644 index 0000000..1c93078 --- /dev/null +++ b/blog/posts/2024-08-hello-world.md @@ -0,0 +1,57 @@ +--- +draft: false +date: 2024-08-12 +categories: + - website + - documentation + - mkdocs +authors: + - gradleup +--- + +# Hello, World! + +🐘🎈 GradleUp, a volunteer-driven umbrella GitHub org focused on better Java, Kotlin and Android developer experience with Gradle, got a new website! + + + +## What is GradleUp? + +GradleUp is a volunteer-driven umbrella GitHub organization +focusing on simplifying developer experience with [Gradle Build Tool (a.k.a. Gradle)](https://gradle.org/), +in particular for Java, Kotlin and Android projects. +We host components and ensure their long-term sustainability. + +Our scope includes all things that help to achieve great user and developer experience when working with Gradle. +It includes but not limited to plugins, developer tools, integrations, documentation or community content. + +## So, a Website? + +The first release includes: + +- Listing of the [GradleUp Projects](../../projects/README.md) +- Initial [Governance Charter](../../docs/community/governance.md) +- [Contributing](../../docs/community/participate.md)and + [New Component Hosting](../../docs/community/hosting.md) guidelines. +- And this blog! + +## Under the Hood + +The site is built with [MkDocs](https://www.mkdocs.org/), +[MkDocs Multirepo Plugin](https://github.com/jdoiro3/mkdocs-multirepo-plugin/tree/main), +and [Material for MkDocs](https://squidfunk.github.io/mkdocs-material). +For development, everything is powered by Dev Containers and GitHub Actions. +As all other resources, the site is open source and open for contributions and new ideas. +Check out the [Contributing Guide](../../CONTRIBUTING.md). + +We’re looking forward to establishing the public communication channels, and onboarding more plugins, developer tools and other cool Gradle things. +Adventure is out there! + +## Credits + +This site is a team effort. +We embed documentation created by many contributors to +[GradleUp Projects](../../projects/README.md). +Also, kudos to [Oleg Nenashev](https://github.com/oleg-nenashev) for working on this website and the community foundations, and welcome to the team! + + diff --git a/mkdocs.yml b/mkdocs.yml index 2f91cba..b2272bd 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -30,6 +30,8 @@ nav: - NMCP (New Maven Central Publishing): nmcp/README.md - Shadow: shadow/README.md - Hosting New Projects: docs/community/hosting.md + - Blog: + - blog/index.md - Participate: - Community Channels: docs/community/participate.md - GradleUp Team: docs/community/team.md @@ -45,10 +47,18 @@ nav: plugins: - search - autorefs + - blog - macros - mkdocs-pdf - social - same-dir + - rss: + match_path: blog/posts/.* + date_from_meta: + as_creation: date + categories: + - categories + - tags - group: enabled: !ENV [FULL_BUILD, true] plugins: @@ -171,6 +181,9 @@ extra: - icon: fontawesome/brands/github link: https://github.com/GradleUp name: GitHub + - icon: /fontawesome/solid/rss + link: feed_rss_created.xml + name: RSS # analytics: # provider: google # property: TODO diff --git a/overrides/main.html b/overrides/main.html new file mode 100644 index 0000000..b2f51a8 --- /dev/null +++ b/overrides/main.html @@ -0,0 +1,7 @@ +{% extends "base.html" %} + +{% block extrahead %} + + + +{% endblock %} From 3f6ed47aa9114932610f514f9309f6bda563e867 Mon Sep 17 00:00:00 2001 From: Oleg Nenashev Date: Fri, 9 Aug 2024 23:00:30 +0200 Subject: [PATCH 2/8] Update .devcontainer/requirements.txt --- .devcontainer/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.devcontainer/requirements.txt b/.devcontainer/requirements.txt index 7c69747..7c8996e 100644 --- a/.devcontainer/requirements.txt +++ b/.devcontainer/requirements.txt @@ -11,7 +11,7 @@ mkdocs-multirepo-plugin==0.6.3 mkdocs-redirects==1.2.1 mkdocs-extra-sass-plugin==0.1.0 mkdocs-render-swagger-plugin==0.1.1 -mkdocs-rss-plugin-1.15.0 +mkdocs-rss-plugin==1.15.0 mkdocs-same-dir==0.1.3 mkdocs-pdf==0.1.1 livereload==2.6.3 From 7ebbe60ad124423afa85f61a9ad713b8fa322591 Mon Sep 17 00:00:00 2001 From: Oleg Nenashev Date: Tue, 20 Aug 2024 08:08:59 +0200 Subject: [PATCH 3/8] Use Hashnoade as a blog engine --- blog/.authors.yml | 6 ---- blog/images/icon/rss.svg | 4 --- blog/index.md | 5 --- blog/posts/2024-08-hello-world.md | 57 ------------------------------- mkdocs.yml | 13 +++---- 5 files changed, 7 insertions(+), 78 deletions(-) delete mode 100644 blog/.authors.yml delete mode 100644 blog/images/icon/rss.svg delete mode 100644 blog/index.md delete mode 100644 blog/posts/2024-08-hello-world.md diff --git a/blog/.authors.yml b/blog/.authors.yml deleted file mode 100644 index ab46dd9..0000000 --- a/blog/.authors.yml +++ /dev/null @@ -1,6 +0,0 @@ -authors: - gradleup: - name: GradleUp Team - description: > - GradleUp organizing team - avatar: https://github.com/gradleup.png diff --git a/blog/images/icon/rss.svg b/blog/images/icon/rss.svg deleted file mode 100644 index 7531837..0000000 --- a/blog/images/icon/rss.svg +++ /dev/null @@ -1,4 +0,0 @@ - - - - diff --git a/blog/index.md b/blog/index.md deleted file mode 100644 index af17fbd..0000000 --- a/blog/index.md +++ /dev/null @@ -1,5 +0,0 @@ -# GradleUp Blog - -[RSS feed of created content]({{ config.site_url }}feed_rss_created.xml) -[RSS feed of updated content]({{ config.site_url }}feed_rss_updated.xml) - diff --git a/blog/posts/2024-08-hello-world.md b/blog/posts/2024-08-hello-world.md deleted file mode 100644 index 1c93078..0000000 --- a/blog/posts/2024-08-hello-world.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -draft: false -date: 2024-08-12 -categories: - - website - - documentation - - mkdocs -authors: - - gradleup ---- - -# Hello, World! - -🐘🎈 GradleUp, a volunteer-driven umbrella GitHub org focused on better Java, Kotlin and Android developer experience with Gradle, got a new website! - - - -## What is GradleUp? - -GradleUp is a volunteer-driven umbrella GitHub organization -focusing on simplifying developer experience with [Gradle Build Tool (a.k.a. Gradle)](https://gradle.org/), -in particular for Java, Kotlin and Android projects. -We host components and ensure their long-term sustainability. - -Our scope includes all things that help to achieve great user and developer experience when working with Gradle. -It includes but not limited to plugins, developer tools, integrations, documentation or community content. - -## So, a Website? - -The first release includes: - -- Listing of the [GradleUp Projects](../../projects/README.md) -- Initial [Governance Charter](../../docs/community/governance.md) -- [Contributing](../../docs/community/participate.md)and - [New Component Hosting](../../docs/community/hosting.md) guidelines. -- And this blog! - -## Under the Hood - -The site is built with [MkDocs](https://www.mkdocs.org/), -[MkDocs Multirepo Plugin](https://github.com/jdoiro3/mkdocs-multirepo-plugin/tree/main), -and [Material for MkDocs](https://squidfunk.github.io/mkdocs-material). -For development, everything is powered by Dev Containers and GitHub Actions. -As all other resources, the site is open source and open for contributions and new ideas. -Check out the [Contributing Guide](../../CONTRIBUTING.md). - -We’re looking forward to establishing the public communication channels, and onboarding more plugins, developer tools and other cool Gradle things. -Adventure is out there! - -## Credits - -This site is a team effort. -We embed documentation created by many contributors to -[GradleUp Projects](../../projects/README.md). -Also, kudos to [Oleg Nenashev](https://github.com/oleg-nenashev) for working on this website and the community foundations, and welcome to the team! - - diff --git a/mkdocs.yml b/mkdocs.yml index 45b2df0..b4e941a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -30,8 +30,6 @@ nav: - NMCP (New Maven Central Publishing): nmcp/README.md - Shadow: shadow/README.md - Hosting New Projects: docs/community/hosting.md - - Blog: - - blog/index.md - Participate: - Community Channels: docs/community/participate.md - GradleUp Team: docs/community/team.md @@ -39,6 +37,7 @@ nav: - Contributing to the Website: ./CONTRIBUTING.md - Governance: docs/community/governance.md - Code of Conduct: org/CODE_OF_CONDUCT.md + - Blog: https://blog.gradleup.com/ - Resources: - Community Support: org/SUPPORT.md - Security Policy: org/SECURITY.md @@ -47,7 +46,6 @@ nav: plugins: - search - autorefs - - blog - macros - mkdocs-pdf - social @@ -181,12 +179,15 @@ extra: - icon: fontawesome/brands/github link: https://github.com/GradleUp name: GitHub - - icon: /fontawesome/solid/rss - link: feed_rss_created.xml - name: RSS - icon: fontawesome/brands/slack link: docs/community/participate.md#slack name: Slack + - icon: /fontawesome/solid/blog + link: https://blog.gradleup.com + name: Blog + - icon: /fontawesome/solid/rss + link: https://blog.gradleup.com/rss.xml + name: Blog - RSS # analytics: # provider: google From 01950ce79b270e1b340cb7b98b6c8e1280ae8e7a Mon Sep 17 00:00:00 2001 From: Oleg Nenashev Date: Tue, 20 Aug 2024 08:21:01 +0200 Subject: [PATCH 4/8] Add GradleUp blog to /participate --- docs/community/participate.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/docs/community/participate.md b/docs/community/participate.md index a25312b..a67dd7d 100644 --- a/docs/community/participate.md +++ b/docs/community/participate.md @@ -1,7 +1,25 @@ -# GradleUp Community Channels +--- +title: Participate in GradleUp +description: > + Subscribe to the GradleUp news, + join the discussions on Slack and GitHub issues +--- [![Slack: GradleUp on the Gradle Community Slack](https://img.shields.io/badge/Slack-%23gradleup-brightgreen?style=flat&logo=slack)](./#slack) +Subscribe to the GradleUp news, join the discussions on Slack and GitHub issues. +All code and non-code contributions are welcome! + +## News + +We have a blog on [blog.gradleup.com](https://blog.gradleup.com/). +There we will be publishing the key updates on what's up in GradleUp. +You can also subscribe to the blog as a [newsletter](https://blog.gradleup.com/newsletter) +or [RSS feed](https://blog.gradleup.com/rss.xml). + +Guest posts by GradleUp users and component maintainers are welcome, too! +Reach out to us on Slack if interested + ## GitHub Issues Each project repository has GitHub Issues enabled. From aa5b671c3856e5cf0634d7c10681f108a241bffc Mon Sep 17 00:00:00 2001 From: Oleg Nenashev Date: Tue, 20 Aug 2024 06:28:38 +0000 Subject: [PATCH 5/8] Devcontainer - Wipe broken cache on Apple Arm --- .devcontainer/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index b887480..7d4295a 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,6 +1,6 @@ FROM python:3.10.4-slim-buster -RUN apt-get update +RUN apt-get clean all && apt-get update RUN apt-get install -y libsass-dev build-essential libcairo2 git libpango-1.0-0 libpangoft2-1.0-0 pangocairo-1.0 pngquant COPY requirements.txt /build/requirements.txt From 4512e055d9be59f90d88ca17318687edbde47d8c Mon Sep 17 00:00:00 2001 From: Oleg Nenashev Date: Tue, 20 Aug 2024 06:37:09 +0000 Subject: [PATCH 6/8] Fix colors for the dark mode, add Blog to the landing --- overrides/home.html | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/overrides/home.html b/overrides/home.html index d0329ab..217eecf 100644 --- a/overrides/home.html +++ b/overrides/home.html @@ -55,6 +55,12 @@ .mdx-hero__buttons { margin-bottom: 20px; + + } + + .md-button { + margin-left: 5px; + margin-right: 5px; } .mdx-container { @@ -69,6 +75,12 @@ text-align:center; } } + + [data-md-color-scheme="slate"] { + .md-button { + color: #f8f8f8; + } + }
@@ -85,6 +97,9 @@

GradleUp

Our Projects + + Blog + Contributing From d3758144db6f396f65144d2197621535a34e5eff Mon Sep 17 00:00:00 2001 From: Oleg Nenashev Date: Tue, 20 Aug 2024 08:50:13 +0200 Subject: [PATCH 7/8] Embedded RSS is YAGNI --- .devcontainer/requirements.txt | 1 - overrides/main.html | 7 ------- 2 files changed, 8 deletions(-) delete mode 100644 overrides/main.html diff --git a/.devcontainer/requirements.txt b/.devcontainer/requirements.txt index 7c8996e..d764670 100644 --- a/.devcontainer/requirements.txt +++ b/.devcontainer/requirements.txt @@ -11,7 +11,6 @@ mkdocs-multirepo-plugin==0.6.3 mkdocs-redirects==1.2.1 mkdocs-extra-sass-plugin==0.1.0 mkdocs-render-swagger-plugin==0.1.1 -mkdocs-rss-plugin==1.15.0 mkdocs-same-dir==0.1.3 mkdocs-pdf==0.1.1 livereload==2.6.3 diff --git a/overrides/main.html b/overrides/main.html deleted file mode 100644 index b2f51a8..0000000 --- a/overrides/main.html +++ /dev/null @@ -1,7 +0,0 @@ -{% extends "base.html" %} - -{% block extrahead %} - - - -{% endblock %} From fe3399b72f7594ba9f488f020654c4ee4d5da92e Mon Sep 17 00:00:00 2001 From: Oleg Nenashev Date: Tue, 20 Aug 2024 08:52:00 +0200 Subject: [PATCH 8/8] Remove the RSS plugin from the configuration, too --- mkdocs.yml | 7 ------- 1 file changed, 7 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 53d4844..b3c1929 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -52,13 +52,6 @@ plugins: cards_layout_options: background_color: "#2A465B" - same-dir - - rss: - match_path: blog/posts/.* - date_from_meta: - as_creation: date - categories: - - categories - - tags - group: enabled: !ENV [FULL_BUILD, true] plugins: