Skip to content

Commit

Permalink
wip: adds links
Browse files Browse the repository at this point in the history
  • Loading branch information
jmgilman committed Oct 30, 2023
1 parent 6bc2eaf commit 2fd0441
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 6 deletions.
1 change: 1 addition & 0 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ It's critical to understand what those tools are and how they interact together
The quickest way to get started learning is by going through the [onboarding process](./onboarding/index.md).
For more in-depth documentation, please review the [reference section](./reference/index.md).
Before contributing to an `Earthfile`, please review the [style guide](./style.md).
If you want to learn how to build an `Earthfile` from scratch, check out the [available guides](./guides/index.md).
17 changes: 11 additions & 6 deletions docs/src/onboarding/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,18 +144,23 @@ Due to the relative flexibility of Earthly, it's possible to structure an `Earth
To provide consistency across our projects, we have implemented a style guide which brings a level of standardization to
`Earthfile`s.

The next step after reviewing the style guide is taking a look at the examples provided in the `catalyst-ci` repository.
The examples are broken up by language and serve as a starter template for getting off the ground quickly.
Reviewing the examples also helps with connecting the concepts discussed in this onboarding guide with actual code.
The next step after reviewing the style guide is taking a look at available [guides](../guides/index.md) for performing specific
tasks with Catalyst CI.
The guides are broken up by language or topic and provide a starter template for getting off the ground quickly.
Reviewing the guides also helps with connecting the concepts discussed in this onboarding guide with actual code.
If the task you're working on is not covered in a guide, it's still recommended you read at least one of the other guides in order
get a more in-depth understanding of building with Catalyst CI.

Experimentation is also encouraged.
The CI process runs on every single commit, even commits to PRs.
You can utilize this fact to begin experimenting with an `Earthfile` and seeing how the CI reacts to different targets.
The only limitation is that not all targets execute fully in a PR setting (i.e. no artifacts are published/released).

Finally, if you get stuck, or have a need to understand the the CI process more, there is reference documentation available which
covers not only individual targets, but also how the entire CI process operates under the hood.
You may also use the discussions section of the `catalyst-ci` repository to ask questions specific to the CI process.
Finally, if you get stuck, or have a need to understand the the CI process more, there is
[reference documentation](../reference/index.md) available which covers not only individual targets, but also how the entire CI
process operates under the hood.
You may also use the [discussions](https://github.com/input-output-hk/catalyst-ci/discussions/landing) section of the `catalyst-ci`
repository to ask questions specific to the CI process.

You are now equipped and ready to start using the Catalyst CI!
We are very open-source friendly and will review all feedback/PRs made against the repository.
Expand Down

0 comments on commit 2fd0441

Please sign in to comment.