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

Fixed broken links in docs/android and docs/ci folders #21

Merged
merged 3 commits into from
Oct 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/android/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ Gradle provides various options to improve build performance, including **build
org.gradle.parallel=true
```

To explore more optimization techniques and configure your builds for better performance, check out our detailed guide: [Gradle Build Optimization](docs/android/optimization.md).
To explore more optimization techniques and configure your builds for better performance, check out our detailed guide: [Gradle Build Optimization](../../docs/android/optimization.md).

For further information, visit the **official** [Optimizing Builds Guide](https://developer.android.com/build/optimize-your-build).

Expand Down Expand Up @@ -142,7 +142,7 @@ configurations.all {
```
For more troubleshooting tips, visit the **official** [Troubleshooting AGP](https://developer.android.com/build/troubleshoot) page.

You can also check the [Gradle Troubleshooting](docs/android/troubleshooting.md) page for additional help with Gradle-specific issues.
You can also check the [Gradle Troubleshooting](../../docs/android/troubleshooting.md) page for additional help with Gradle-specific issues.

## References

Expand Down
6 changes: 3 additions & 3 deletions docs/android/optimization.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

This page references key external resources to help you optimize your Android Gradle builds. Below are some techniques and guides:

- [Build Caching](https://developer.android.com/build/optimize-your-build#build-cache) – Reduce unnecessary tasks by reusing outputs from previous builds.
- [Parallel Execution](https://developer.android.com/build/optimize-your-build#parallel-execution) – Execute independent tasks in parallel to speed up the build.
- [Gradle Daemon](https://developer.android.com/build/optimize-your-build#gradle-daemon) – Optimize build performance by using a persistent process for faster execution.
- [Build Caching](https://developer.android.com/build/optimize-your-build#use-the-configuration-cache) – Reduce unnecessary tasks by reusing outputs from previous builds.
- [Parallel Execution](https://docs.gradle.org/current/userguide/performance.html#parallel_execution) – Execute independent tasks in parallel to speed up the build.
- [Gradle Daemon](https://docs.gradle.org/current/userguide/gradle_daemon.html#enable_deamon) – Optimize build performance by using a persistent process for faster execution.

More original content will be added soon to cover performance monitoring, advanced caching strategies, and Gradle tuning specific to large-scale projects.
4 changes: 2 additions & 2 deletions docs/ci/github-actions.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Executing Gradle builds on GitHub Actions

!!! tip
Top engineering teams using GitHub Actions 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.
Top engineering teams using GitHub Actions have been able to reduce CI build time by up to 90% by using the Gradle Build Cache. [Register here](https://dpeuniversity.gradle.com/app/courses/ec69d0b8-9171-4969-ac3e-82dea16f87b0) 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. [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.

Expand Down Expand Up @@ -195,4 +195,4 @@ This image reveals that the repository contains a version of `com.google.guava:g

You can view a list of all vulnerabilities by navigating to `Security -> Dependabot`.

![View dependency alerts](images/github-actions-dependency-alerts.png)
![View dependency alerts](images/github-actions-dependency-alerts.png)
2 changes: 1 addition & 1 deletion docs/ci/jenkins.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Executing Gradle builds on Jenkins

!!! tip
Top engineering teams using Jenkins 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.
Top engineering teams using Jenkins have been able to reduce CI build time by up to 90% by using the Gradle Build Cache. [Register here](https://dpeuniversity.gradle.com/app/courses/ec69d0b8-9171-4969-ac3e-82dea16f87b0) 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. [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.

Expand Down
2 changes: 1 addition & 1 deletion docs/ci/teamcity.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Executing Gradle builds on TeamCity

!!! tip
Top engineering teams using TeamCity 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.
Top engineering teams using TeamCity have been able to reduce CI build time by up to 90% by using the Gradle Build Cache. [Register here](https://dpeuniversity.gradle.com/app/courses/ec69d0b8-9171-4969-ac3e-82dea16f87b0) 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. [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.

Expand Down
6 changes: 3 additions & 3 deletions docs/ci/travis-ci.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Executing Gradle builds on Travis CI

!!! tip
Top engineering teams using Travis 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.
Top engineering teams using Travis CI have been able to reduce CI build time by up to 90% by using the Gradle Build Cache. [Register here](https://dpeuniversity.gradle.com/app/courses/ec69d0b8-9171-4969-ac3e-82dea16f87b0) 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. [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.

Expand Down Expand Up @@ -60,7 +60,7 @@ Travis CI is a free, cloud-based CI solution provider making it an excellent cho

Travis CI requires you to check in a [configuration file](https://docs.travis-ci.com/user/customizing-the-build/) with your source code named `.travis.yml`. This file contains all relevant instructions for building the project.

The following configuration file tells Travis CI to build a Java project with JDK 8, skip the usual [default execution step](https://docs.travis-ci.com/user/customizing-the-build/#Skipping-the-Installation-Step), and run the Gradle build with the Wrapper.
The following configuration file tells Travis CI to build a Java project with JDK 8, skip the usual [default execution step](https://docs.travis-ci.com/user/job-lifecycle/#skip-the-installation-phase), and run the Gradle build with the Wrapper.

```yaml
language: java
Expand All @@ -82,7 +82,7 @@ Select the project from the Travis CI profile. After activating the repository f

### Enable caching of downloaded artifacts

Gradle's dependency management mechanism resolves declared modules and their corresponding artifacts from a binary repository. Once downloaded, the files will be re-used from the cache. You need to tell Travis CI explicitly that you want to [store and use the Gradle cache and Wrapper](https://docs.travis-ci.com/user/languages/java/#Caching) for successive invocations of the build.
Gradle's dependency management mechanism resolves declared modules and their corresponding artifacts from a binary repository. Once downloaded, the files will be re-used from the cache. You need to tell Travis CI explicitly that you want to [store and use the Gradle cache and Wrapper](https://docs.travis-ci.com/user/languages/java/#caching) for successive invocations of the build.

```yaml
before_cache:
Expand Down
Loading