diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 154fede..1b9ef16 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -51,15 +51,6 @@ jobs: name: github-pages path: "_site/" - - name: Build the docs site for gradle.org - run: mkdocs build -f mkdocs-dotorg.yml - - - name: Upload artifact - uses: actions/upload-pages-artifact@v1 - with: - name: dotorg-site - path: "_dotorg_site/" - # Deployment job deploy: environment: diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index fbea45b..241aa19 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -25,7 +25,7 @@ It is possible to deploy the site instance locally or inside a Dev Container. This repository includes the Dev Container definition that you can use in Visual Studio Code or in IntelliJ Platform to spin up the local development environment. -### Running locally +### Running locally Requirements: diff --git a/mkdocs-dotorg.yml b/mkdocs-dotorg.yml deleted file mode 100644 index f2695ca..0000000 --- a/mkdocs-dotorg.yml +++ /dev/null @@ -1,219 +0,0 @@ -site_name: Gradle Community Sub-site -site_description: >- - This is an open-source site for all Gradle community matters, - including governance, artwork, events, and public infrastructure. -copyright: > - For content - Copyright © 2024 - All contributors to the repository and included components. - The original content licenses and copyrights from the included repositories are preserved, - you can find them in the linked repositories. - - The GRADLE trademark is the property of Gradle, Inc. - Use of the term GRADLE on this website and any content and/or materials available through this website is - for identification purposes only and does not imply sponsorship or endorsement by Gradle, Inc. -docs_dir: docs -repo_url: https://github.com/gradle/community -repo_name: Gradle Community repo -edit_uri: edit/main/docs/ -site_url: https://gradle.org/community - -# Build -site_dir: _dotorg_site - -# Theme -theme: - name: material - highlightjs: true - features: - - announce.dismiss - - content.action.edit - - content.action.view - - content.code.annotate - - content.code.copy - - content.code.select - - content.tabs.link - - content.tooltips - # - header.autohide - # - navigation.expand - - navigation.footer - # NOT compatible qith toc.integrate - # - navigation.indexes - - navigation.path - # - navigation.instant - # - navigation.instant.prefetch - # - navigation.instant.progress - # - navigation.prune - - navigation.sections - - navigation.expand - - navigation.tabs - # - navigation.tabs.sticky - - navigation.top - - navigation.tracking - - search.highlight - - search.share - - search.suggest - - toc.follow - - toc.integrate - palette: - - - scheme: default - media: "(prefers-color-scheme: light)" - primary: custom - toggle: - icon: material/brightness-7 - name: Switch to dark mode - - - scheme: slate - media: "(prefers-color-scheme: dark)" - primary: custom - toggle: - icon: material/brightness-4 - name: Switch to light mode - font: - # TODO: use the site's scheme - # text: Lato Lite - code: Roboto Mono - favicon: images/logos/gradle.svg - logo: images/logos/gradle.svg - icon: - repo: fontawesome/brands/github - - -extra_css: - - assets/css/gradle.css - -extra: - social: - - icon: fontawesome/brands/slack - link: https://gradle.org/slack-invite - name: Slack - - icon: fontawesome/brands/github - link: https://github.com/gradle - name: GitHub - - icon: fontawesome/brands/twitter - link: https://twitter.com/gradle - name: Twitter/X - - icon: fontawesome/brands/linkedin - link: https://www.linkedin.com/company/gradle - name: LinkedIn - - icon: fontawesome/brands/mastodon - link: https://mastodon.social/@Gradle - name: Mastodon -# analytics: -# provider: google -# property: TODO - -nav: - - Home: README.md - - Cookbook: - - Gradle on CI: - - Jenkins: cookbook/ci/jenkins.md - - TeamCity: cookbook/ci/teamcity.md - - Github Actions: cookbook/ci/github-actions.md - - Travis CI: cookbook/ci/travis-ci.md - - Participate: - - Getting Started: contributing/README.md - - Community Slack: contributing/community-slack.md - - Contributing to Gradle Build Tool: - - Overview: gradle/CONTRIBUTING.md - - Gradle Build Tool Architecture: gradle/architecture/README.md - - Contributing to Documentation: - - Overview: contributing/documentation/README.md - - Gradle Build Tool Docs: gradle/platforms/documentation/docs/README.md - - Community Site Docs: CONTRIBUTING.md - - Reporting Vulnerabilities: dotgithub/SECURITY.md - - Public Roadmap: roadmap/README.md - - Code of Conduct: dotgithub/CODE_OF_CONDUCT.md - - Key Projects: - - Key Projects: projects/README.md - - Core: - - Gradle Build Tool: gradle/README.md - - Declarative Gradle: declarative-gradle/README.md - - Gradle X: gradlex/index.md - - Gradle Build Tool: build-server-for-gradle/README.md - - Integrations: - - GitHub Actions: github-actions/README.md - - VS Code: vscode-gradle/README.md - - Developer Tools: - - Gradle Profiler: gradle-profiler/README.md - - Gradle Doctor: gradle-doctor/docs/index.md - - Events: - - Events Overview: events/README.md - - Google Summer of Code: events/gsoc/README.md - - Resources: - - Resources: resources/README.md - - Public Roadmap: roadmap/README.md - - Code of Conduct: dotgithub/CODE_OF_CONDUCT.md -# - Resources: -# - Gradle Docs: https://docs.gradle.org/ -# - Blog: https://blog.gradle.org/ -# - Newsletter: https://newsletter.gradle.org/ -# - Releases: https://gradle.org/releases -# - Plugin Portal: https://plugins.gradle.org/ -# - Slack Archive: https://www.linen.dev/s/gradle-community -# - Stack Overflow: https://stackoverflow.com/questions/tagged/gradle -# - Commercial: -# - Develocity: https://gradle.com/develocity -# - Service Providers: https://gradle.org/services/ -# - Training: https://gradle.org/courses - -plugins: - - search - - autorefs -# FIXME: Collision on GitHub Actions, to be fixed later -# - macros - - mkdocs-pdf - # OpenGraphs - - social - - group: - enabled: !ENV [FULL_BUILD, true] - plugins: - - multirepo: - cleanup: false - keep_docs_dir: true - nav_repos: - - name: dotgithub - import_url: 'https://github.com/gradle/.github?branch=master&edit_uri=/blob/master/' - - name: gradle - import_url: 'https://github.com/gradle/gradle?branch=master&edit_uri=/blob/master/' - imports: [ "/*.md", "/*.png", "platforms/documentation/docs/README.md", "architecture/*", "architecture/standards/*" ] - - name: roadmap - import_url: 'https://github.com/gradle/build-tool-roadmap?branch=main&edit_uri=/blob/main/' - imports: [ "README.md" ] - - name: gradle-profiler - import_url: 'https://github.com/gradle/gradle-profiler?branch=master&edit_uri=/blob/master/' - imports: [ "README.md" ] - - name: github-actions - import_url: 'https://github.com/gradle/actions?branch=main&edit_uri=/blob/main/' - imports: [ "README.md", "*" ] - - name: declarative-gradle - import_url: 'https://github.com/gradle/declarative-gradle?branch=main&edit_uri=/blob/main/' - imports: [ "README.md", "**/README.md" ] - - name: gradlex - import_url: 'https://github.com/gradlex-org/gradlex-org.github.io?branch=main&edit_uri=/blob/main/' - imports: [ "index.md", "favicon.png" ] - - name: gradle-doctor - import_url: 'https://github.com/runningcode/gradle-doctor?branch=master&edit_uri=/blob/master/' - imports: [ "docs/*" ] - - name: build-server-for-gradle - import_url: 'https://github.com/microsoft/build-server-for-gradle?branch=develop&edit_uri=/blob/develop/' - imports: [ "*.md", "images/*" ] - - name: vscode-gradle - import_url: 'https://github.com/microsoft/vscode-gradle?branch=develop&edit_uri=/blob/develop/' - imports: [ "*.md", "images/*" ] - - redirects: - redirect_maps: - -# Markdown -markdown_extensions: - - pymdownx.highlight: - anchor_linenums: true - line_spans: __span - pygments_lang_class: true - - pymdownx.inlinehilite - - pymdownx.snippets - - pymdownx.superfences - - pymdownx.tabbed: - alternate_style: true - - toc: - permalink: '#' - - attr_list diff --git a/mkdocs.yml b/mkdocs.yml index 9074762..149780f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -98,9 +98,10 @@ extra: - icon: fontawesome/brands/mastodon link: https://mastodon.social/@Gradle name: Mastodon -# analytics: -# provider: google -# property: TODO + +analytics: + provider: google + property: G-7W7NC6YNPT nav: - Home: README.md @@ -108,7 +109,7 @@ nav: - Gradle on CI: - Jenkins: cookbook/ci/jenkins.md - TeamCity: cookbook/ci/teamcity.md - - Github Actions: cookbook/ci/github-actions.md + - GitHub Actions: cookbook/ci/github-actions.md - Travis CI: cookbook/ci/travis-ci.md - Participate: - Getting Started: contributing/README.md @@ -124,19 +125,6 @@ nav: - Reporting Vulnerabilities: dotgithub/SECURITY.md - Public Roadmap: roadmap/README.md - Code of Conduct: dotgithub/CODE_OF_CONDUCT.md -# - Key Projects: -# - Key Projects: projects/README.md -# - Core: -# - Gradle Build Tool: gradle/README.md -# - Declarative Gradle: declarative-gradle/README.md -# - Gradle X: gradlex/index.md -# - Gradle Build Tool: build-server-for-gradle/README.md -# - Integrations: -# - GitHub Actions: github-actions/README.md -# - VS Code: vscode-gradle/README.md -# - Developer Tools: -# - Gradle Profiler: gradle-profiler/README.md -# - Gradle Doctor: gradle-doctor/docs/index.md - Events: - Events Overview: events/README.md - Google Summer of Code: events/gsoc/README.md @@ -189,18 +177,7 @@ plugins: - name: github-actions import_url: 'https://github.com/gradle/actions?branch=main&edit_uri=/blob/main/' imports: [ "README.md", "*" ] - - name: gradlex - import_url: 'https://github.com/gradlex-org/gradlex-org.github.io?branch=main&edit_uri=/blob/main/' - imports: [ "index.md", "favicon.png" ] - - name: gradle-doctor - import_url: 'https://github.com/runningcode/gradle-doctor?branch=master&edit_uri=/blob/master/' - imports: [ "docs/*" ] - - name: build-server-for-gradle - import_url: 'https://github.com/microsoft/build-server-for-gradle?branch=develop&edit_uri=/blob/develop/' - imports: [ "*.md", "images/*" ] - - name: vscode-gradle - import_url: 'https://github.com/microsoft/vscode-gradle?branch=develop&edit_uri=/blob/develop/' - imports: [ "*.md", "images/*" ] + - redirects: redirect_maps: