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

Configuration source and trigger docs refresh #8703

Merged
merged 24 commits into from
May 21, 2024

Conversation

rosieyohannan
Copy link
Contributor

@rosieyohannan rosieyohannan commented Apr 16, 2024

Description

  • Add full descriptions and setup steps for config sources and triggers to the pipelines overview
  • Move conifg source and trigger info from integrations pages to the pipelines overview and replace with links
  • Update screenshots

Reasons

Help customers get a full understanding on what config sources and triggers are and how to set them up

Content Checklist

Please follow our style when contributing to CircleCI docs. Our style guide is here: https://circleci.com/docs/style/style-guide-overview.

Please take a moment to check through the following items when submitting your PR (this is just a guide so will not be relevant for all PRs) 😸:

  • Break up walls of text by adding paragraph breaks.
  • Consider if the content could benefit from more structure, such as lists or tables, to make it easier to consume.
  • Keep the title between 20 and 70 characters.
  • Consider whether the content would benefit from more subsections (h2-h6 headings) to make it easier to consume.
  • Check all headings h1-h6 are in sentence case (only first letter is capitalized).
  • Is there a "Next steps" section at the end of the page giving the reader a clear path to what to read next?
  • Include relevant backlinks to other CircleCI docs/pages.


Pipelines include your workflows, which coordinate your jobs. Pipelines have a fixed, linear lifecycle, and are associated with a specific actor. Pipelines trigger when a change is pushed to a project that has a CircleCI configuration file included, and can also be scheduled, triggered manually through the CircleCI app, or using the API.

== Dashboard
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line 19-34 already existed so no need to review at this time, changes are needed but out of scope for this PR. I've converted the file so it looks like the whole file is new.

@rosieyohannan rosieyohannan marked this pull request as ready for review April 18, 2024 14:36
@rosieyohannan rosieyohannan requested review from a team as code owners April 18, 2024 14:36
Copy link
Contributor

@sebastian-lerner sebastian-lerner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i found some typos but no major issues from my end

jekyll/_cci2/pipelines.adoc Outdated Show resolved Hide resolved
jekyll/_cci2/pipelines.adoc Outdated Show resolved Hide resolved
jekyll/_cci2/pipelines.adoc Outdated Show resolved Hide resolved
jekyll/_cci2/pipelines.adoc Outdated Show resolved Hide resolved
jekyll/_cci2/pipelines.adoc Outdated Show resolved Hide resolved
@sebastian-lerner
Copy link
Contributor

it would be good to have benny give it a review as well and make sure she has no concerns

jekyll/_cci2/pipelines.adoc Outdated Show resolved Hide resolved
jekyll/_cci2/pipelines.adoc Outdated Show resolved Hide resolved
jekyll/_cci2/pipelines.adoc Outdated Show resolved Hide resolved
Copy link
Contributor

@BeFunes BeFunes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

Co-authored-by: Kelvin Tay <kelvintaywl@gmail.com>
@rosieyohannan rosieyohannan merged commit 4a19c47 into master May 21, 2024
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants