Merge pull request #107 from Tanish-Ranjan/feat/seo-metadata

Fixed formatting, spelling, grammar and added seo metadata to all pages

docs/CONTRIBUTING.md

@@ -20,7 +20,7 @@ Detailed instructions are provided below.
 
 ## Contributing Content
 
-### Contributing to Gradle Cookbok
+### Contributing to Gradle Cookbook
 
 See the [Gradle Cookbook Contributor Guide](./cookbook/CONTRIBUTING.md).
 
@@ -57,7 +57,7 @@ The same Dev Container is used for CI/CD, and it is the recommended way for loca
 Requirements:
 
 - Python3 and PiP (Python's package manager), recent versions
-- Linux, MacOS or Windows WSL-2 environment.
+- Linux, macOS or Windows WSL-2 environment.
   Windows native may work but it is not tested.
 
 For now, you need to install the dependencies:
@@ -78,7 +78,7 @@ To do live development, use the following command to provision the site on `http
 mkdocs serve
 ```
 
-Note that the Mkdocs Multi-Repo plugin is quite slow,
+Note that the MkDocs Multi-Repo plugin is quite slow,
 and it may take up to 10 seconds to rebuild the website on configuration changes.
 If you develop the local part within this repository (design, content, etc.),
 you can run the `build` and the `serve` commands with the `FULL_BUILD=false` variable, e.g.:

docs/contributing/README.md

@@ -1,3 +1,10 @@
+---
+title: "Contributing to Gradle"
+description: >
+  As in any open-source project, contributions to Gradle are welcome!
+  You can contribute to Gradle Build Tool itself, its documentation, plugins and tools within Gradle's ecosystem.
+---
+
 # Contributing to Gradle
 
 As in any open-source project, contributions to Gradle are welcome!

docs/contributing/community-slack.md

@@ -102,10 +102,10 @@ For other cases, other channels might be preferable:
 
 1. If you suspect a security issue in Gradle Build Tool, plugins, its infrastructure, or other components,
    please avoid discussing it in public.
-   Follow the [Gradle Vulnerability Disclosure Policy](../dotgithub/SECURITY/README.md) so that we can triage the issue and protect other Gradle users.
-3. If you want to report a confirmed and reproducible issue with Gradle Build Tool or other component,
+   Follow the [Gradle Vulnerability Disclosure Policy](dotgithub/SECURITY/README.md) so that we can triage the issue and protect other Gradle users.
+2. If you want to report a confirmed and reproducible issue with Gradle Build Tool or other component,
    use GitHub Issues of the respective GitHub repository associated with the component.
-4. For getting feedback on large-size proposals that will take many months to implement,
+3. For getting feedback on large-size proposals that will take many months to implement,
    it is better to make proposals on Gradle Forums on Discourse: [discuss.gradle.org](https://discuss.gradle.org).
    You can still use Slack to facilitate the discussion
 
@@ -117,7 +117,7 @@ We do not normally provide individual and private support in the community chann
 If you need that, consider contacting one of the [professional services providers](https://gradle.org/services/).
 
 Please abstain from sending direct messages (DMs) unless you have a confidential issue,
-for example, if you suspect a Code of COnduct violation,
+for example, if you suspect a Code of Conduct violation,
 or want to discuss something personal.
 DMing someone with a generic question is not considered appropriate in the community,
 and regular misuse of DMs may be a subject for a [Code of Conduct](https://gradle.org/conduct/) review.

docs/contributing/documentation/README.md

@@ -50,7 +50,7 @@ It includes:
 - The main site (gradle.org)
 - The official blog (blog.gradle.org)
 - The newsletter archive (newsletter.gradle.org)
-- Gradle guides and most of training courses (gradle.org/guides/)
+- Gradle guides and most of the training courses (gradle.org/guides/)
 
 If you want to submit patches to any of those locations,
 please reach out to us on the `#docs` channel.

docs/contributing/spread-the-word.md

@@ -3,12 +3,12 @@ title: "Spread the Word"
 description: >
   As any open source project, we rely on Gradle community members to share news and learnings
   on social media, blogs and other public channels.
-  All content contributons are welcome
+  All content contributions are welcome
 ---
 
 As any open source project, we rely on Gradle community members to share news and learnings
 on social media, blogs and other public channels.
-All content contributons are welcome!
+All content contributions are welcome!
 
 ## Channels
 
@@ -29,7 +29,7 @@ and we will do our best to promote quality content there.
 ### Community News on Slack
 
 On the [Gradle Community Slack](./community-slack.md), we have a `#community-news` channel.
-Everyone is invioted to share their highlights there,
+Everyone is invited to share their highlights there,
 whether it is a new presentation, blog, or a plugin release!
 
 ### Newsletter

docs/cookbook/CONTRIBUTING.md

@@ -1,3 +1,9 @@
+---
+title: "Contributing to the Gradle Cookbook"
+description: >
+    Instructions for contributing to the Gradle Cookbook. Any Contributions are welcome!
+---
+
 # Contributing to the Gradle Cookbook
 
 [![a](https://img.shields.io/badge/slack-%23docs-brightgreen?style=flat&logo=slack)](../contributing/community-slack.md)
@@ -11,7 +17,7 @@ Any contributions are welcome!
 - `#docs` on the [Gradle Community Slack](../contributing/community-slack.md)
 - [GitHub Issues](https://github.com/gradle/community/issues)
 
-## HOWTOs
+## HOW TOs
 
 ### Editing and Adding Pages
 

docs/cookbook/ci/README.md

@@ -1,3 +1,10 @@
+---
+title: "Using Gradle with Continuous Integration Systems"
+description: >
+  References to CI integrations and best practices to to streamline development
+  workflow and ensure efficient builds and deployments with Gradle.
+---
+
 # Using Gradle with Continuous Integration Systems
 
 Gradle has many integrations with Continuous Integration (CI)

docs/cookbook/ci/github-actions.md

@@ -1,3 +1,9 @@
+---
+title: "Executing Gradle builds on GitHub Actions"
+description: >
+  Guide to help you through the process of configuring GitHub Actions for continuous integration (CI) for a Gradle project hosted on GitHub.
+---
+
 # Executing Gradle builds on GitHub Actions
 
 !!! tip
@@ -54,7 +60,7 @@ $ git push
 
 ### Test building the project
 
-The project uses the [Gradle Wrapper](gradle_wrapper.adoc#gradle_wrapper_reference) for building the project. It is a recommended practice for any Gradle project as it enables your project to be built on CI without having to install the Gradle runtime.
+The project uses the [Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html) for building the project. It is a recommended practice for any Gradle project as it enables your project to be built on CI without having to install the Gradle runtime.
 
 Before asking GitHub Actions to build your project, it's useful to ensure that it builds locally. Adding the "CI" environment variable will emulate running the build on GitHub Actions.
 

docs/cookbook/ci/gitlab-ci.md

@@ -1,12 +1,18 @@
+---
+title: "Executing Gradle builds on GitLab CI"
+description: >
+  Guide to help you through the process of configuring GitLab CI for continuous integration (CI) for a Gradle project hosted on GitLab.
+---
+
 # Executing Gradle builds on GitLab CI
 
 !!! tip
-    Top engineering teams using GitLab CI have been able to reduce CI build time by up to 90% by using the Gradle Build Cache. https://gradle.org/training/#build-cache-deep-dive[Register here] for our Build Cache training session to learn how your team can achieve similar results.
+    Top engineering teams using GitLab CI have been able to reduce CI build time by up to 90% by using the Gradle Build Cache. [Register here](https://gradle.org/training/#build-cache-deep-dive) for our Build Cache training session to learn how your team can achieve similar results.
 
 Building Gradle projects doesn't stop with the developer's machine.
-https://en.wikipedia.org/wiki/Continuous_integration[Continuous Integration] (CI) has been a long-established practice for running a build for every single change committed to version control to tighten the feedback loop.
+[Continuous Integration](https://en.wikipedia.org/wiki/Continuous_integration) (CI) has been a long-established practice for running a build for every single change committed to version control to tighten the feedback loop.
 
-In this guide, we'll discuss how to configure link:https://docs.gitlab.com/ee/ci/[GitLab CI] for a Gradle project hosted on GitLab (GitLab.com, self-managed or dedicated).
+In this guide, we'll discuss how to configure [GitLab CI](https://docs.gitlab.com/ee/ci/) for a Gradle project hosted on GitLab (GitLab.com, self-managed or dedicated).
 
 ## Introduction
 

docs/cookbook/ci/jenkins.md

@@ -1,3 +1,9 @@
+---
+title: "Executing Gradle builds on Jenkins"
+description: >
+  Guide to help you through the process of configuring Jenkins for continuous integration (Ci) with a typical Gradle project.
+---
+
 # Executing Gradle builds on Jenkins
 
 !!! tip
@@ -14,7 +20,7 @@ In this guide, we'll discuss how to configure [Jenkins](https://jenkins.io/) for
 - The Java Development Kit (JDK), version 1.7 or higher
 - A Jenkins installation (setup steps explained in this post)
 
-## Setup a typical project
+## Set up a typical project
 
 As an example, this guide is going to focus on a Java-based project. More specifically, a Gradle plugin written in Java and tested with [Spek](https://www.spekframework.org/). First, we'll get the project set up on your local machine before covering the same steps on CI.
 
@@ -39,7 +45,7 @@ BUILD SUCCESSFUL
 14 actionable tasks: 14 executed
 ```
 
-The project provides the [Gradle Wrapper](gradle_wrapper.adoc#gradle_wrapper_reference) as part of the repository. It is a recommended practice for any Gradle project as it enables your project to be built on CI without having to install the Gradle runtime.
+The project provides the [Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html) as part of the repository. It is a recommended practice for any Gradle project as it enables your project to be built on CI without having to install the Gradle runtime.
 
 ### Build scan integration
 

docs/cookbook/ci/teamcity.md

@@ -1,3 +1,9 @@
+---
+title: "Executing Gradle builds on TeamCity"
+description: >
+  Guide to help you through the process of configuring TeamCity for continuous integration (Ci) with a typical Gradle project.
+---
+
 # Executing Gradle builds on TeamCity
 
 !!! tip
@@ -13,7 +19,7 @@ In this guide, we'll discuss how to configure [TeamCity](https://www.jetbrains.c
 - The Java Development Kit (JDK), version 1.8 or higher
 - A TeamCity installation (setup steps explained in this guide)
 
-## Setup a typical project
+## Set up a typical project
 
 For demonstration purposes, this guide is going to focus on building a Java-based project; however, this setup will work with any Gradle-compatible project. More specifically, a Gradle plugin written in Java and tested with [Spek](https://www.spekframework.org/). First, we'll get the project set up on your local machine before covering the same steps on CI.
 
@@ -38,7 +44,7 @@ BUILD SUCCESSFUL
 14 actionable tasks: 14 executed
 ```
 
-The project provides the [Gradle Wrapper](gradle_wrapper.adoc#gradle_wrapper_reference) as part of the repository. It is a recommended practice for any Gradle project as it enables your project to be built on CI without having to install the Gradle runtime.
+The project provides the [Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html) as part of the repository. It is a recommended practice for any Gradle project as it enables your project to be built on CI without having to install the Gradle runtime.
 
 ### Build scan integration
 
@@ -103,7 +109,7 @@ Click the _Run_ button in the top right corner:
 
 ![Run Build](images/teamcity-step-upd.png)
 
-TeamCity will start the build and you’ll be able to view the build progress by clicking _Build Configuration Home_. When the build is finished, you can review the build results by clicking the build number link:
+TeamCity will start the build, and you’ll be able to view the build progress by clicking _Build Configuration Home_. When the build is finished, you can review the build results by clicking the build number link:
 
 ![Build Results](images/teamcity-results.png)
 

docs/cookbook/ci/travis-ci.md

@@ -1,3 +1,9 @@
+---
+title: "Executing Gradle builds on Travis CI"
+description: >
+    Guide to help you through the process of configuring Travis CI for continuous integration (Ci) with a typical Gradle project.
+---
+
 # Executing Gradle builds on Travis CI
 
 !!! tip
@@ -13,7 +19,7 @@ In this guide, we'll discuss how to configure [Travis CI](https://travis-ci.org/
 * A command prompt
 * The Java Development Kit (JDK), version 1.8 or higher
 
-## Setup a typical project
+## Set up a typical project
 
 As example, this guide is going to focus on a Java-based project. More specifically, a Gradle plugin written in Java and tested with [Spek](https://www.spekframework.org/). First, we'll get the project set up on your local machine before covering the same steps on CI.
 
@@ -38,7 +44,7 @@ BUILD SUCCESSFUL
 14 actionable tasks: 14 executed
 ```
 
-The project provides the [Gradle Wrapper](gradle_wrapper.adoc#gradle_wrapper_reference) as part of the repository. It is a recommended practice for any Gradle project as it enables your project to be built on CI without having to install the Gradle runtime.
+The project provides the [Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html) as part of the repository. It is a recommended practice for any Gradle project as it enables your project to be built on CI without having to install the Gradle runtime.
 
 ### Build scan integration
 

docs/events/README.md

@@ -1,3 +1,11 @@
+---
+title: "Gradle Community Events"
+description: >
+  In Gradle, we organize multiple online events,
+  and also often attend Java and open source community conferences
+  like Devoxx or FOSDEM.
+---
+
 # Gradle Community Events
 
 In Gradle, we organize multiple online events,

docs/events/gsoc/2024/gradle-build-server-android.md

@@ -55,7 +55,7 @@ As the popularity of Android development grows, the need for efficient build aut
 **Implemented Features:**
 
 - [x] Took over some work already done by [@Arthurm1](https://github.com/Arthurm1) in [PR#122](https://github.com/microsoft/build-server-for-gradle/pull/122), into [PR#154](https://github.com/microsoft/build-server-for-gradle/pull/154).
-- [x] Utilized build actions to retrieve source sets from composite build projects which allowed for dependency susbtitution.
+- [x] Utilized build actions to retrieve source sets from composite build projects which allowed for dependency substitution.
 - [x] Fixed language extension downcast issue in [PR#160](https://github.com/microsoft/build-server-for-gradle/pull/160) which was breaking composite builds.
 
 <details>
@@ -84,8 +84,8 @@ As the popularity of Android development grows, the need for efficient build aut
 - [x] In case of incompatibility try to find a compatible Java Home in the given order:
     1. GradleJavaHome (Gradle Properties)
     2. UserJavaHome (Retrieved from preferences)
-- [x] Notify client if project's default Java Home was incompatible and we switched to a different Java Home for compatibility.
-- [x] Notify client if the fallback logic couldn't find a compatible Java Home.
+- [x] If project's default Java Home was incompatible, notify client we switched to a different Java Home for compatibility.
+- [x] Notify client, if the fallback logic couldn't find a compatible Java Home.
 
 <details>
 

docs/events/hacktoberfest/README.md

@@ -1,12 +1,17 @@
+---
+title: "Gradle in Hacktoberfest"
+description: >
+   Hacktoberfest is a month-long celebration of open-source projects, their maintainers, and the global community of contributors.
+   In 2024, we’re excited to join as an organization and will be offering special-edition swag to key contributors.
+---
+
 # Gradle in Hacktoberfest
 
 [Hacktoberfest](https://hacktoberfest.com/) is a month-long celebration of open-source projects, their maintainers, and the global community of contributors.
 Many maintainers within the Gradle ecosystem, such as those behind the
-[Gradle plugin for Jenkins](https://plugins.jenkins.io/gradle),
-already include their projects in Hacktoberfest.
+[Gradle plugin for Jenkins](https://plugins.jenkins.io/gradle), already include their projects in Hacktoberfest.
 
-In 2024, we’re excited to join as an organization```
-and will be offering special-edition swag to key contributors.
+In 2024, we’re excited to join as an organization and will be offering special-edition swag to key contributors.
 
 <a class="button button--blue"
    href="https://forms.gle/avUcGctpzW3t8MPJ7"

docs/projects/README.md

@@ -1,9 +1,15 @@
+---
+title: "Key Gradle Projects"
+description: >
+    List of a few key projects within the Gradle Build Tool ecosystem.
+---
+
 # Key Gradle Projects
 
 On this site, we list a few key projects within the Gradle Build Tool ecosystem.
 See the links on the left.
 
-> **DICLAIMER:** The list below is an experimental one.
+> **DISCLAIMER:** The list below is an experimental one.
 > It does not represent an actual list of the project considered
 > key ones by Gradle Inc. or by the Gradle community.
 > No endorsement of one project over another is implied.
@@ -14,16 +20,17 @@ See the links on the left.
 > **NOTE:** There will be a quick-nav grid layout,
 > so we do not bother with a look&feel for now
 
-- Gradle Build Tool
-- Declarative Gradle
-- Gradle Profiler
-- GitHub Actions for Gradle
+- [Gradle Build Tool](https://gradle.org/)
+- [Declarative Gradle](https://declarative.gradle.org/)
+- [Gradle Profiler](https://github.com/gradle/gradle-profiler)
+- [GitHub Actions for Gradle](https://github.com/gradle/gradle-build-action)
 
 ## Independent Community Projects
 
 Here are some projects we would like to highlight
 
-- Gradle X - provides high quality extensions for Gradle Build Tool that make it more pleasant to use
+- [Gradle X](https://gradlex.org/) - provides high quality extensions for Gradle Build Tool that make it more pleasant to use
+- [Gradle Build Server](https://github.com/microsoft/build-server-for-gradle) - an implementation of [Build Server Protocol](https://build-server-protocol.github.io/docs/specification) (BSP) for Gradle
 
 ## Adding your projects
 

docs/resources/social-media.md

@@ -1,3 +1,10 @@
+---
+title: "Gradle on Social Media"
+description: >
+  The open open source project and Gradle Inc. with combined channels is available on several social media platforms.
+  Follow to access plenty of Gradle Build Tool content!
+---
+
 # Gradle on Social Media
 
 ## Our channels

overrides/resources.html

@@ -11,7 +11,7 @@ <h3>
             <img class="section-icon" src="{{ resource.icon }}"/>
           </span>
           <span>{{ resource.section }}</span>
-        </h2>
+        </h3>
       </div>
       <div class="items">
         <ul>