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

[DOCS]: Add topic describing Salt System Architecture for newbies #58664

Merged
merged 9 commits into from Dec 10, 2020

Conversation

barbaricyawps
Copy link
Contributor

What does this PR do?

This PR is a docs-only change that includes two changes:

  • It makes some minor changes to the index.rst file to update the phrasing
  • It adds a new topic called Salt System Architecture that describes the core components of Salt (including a fancy image)

What issues does this PR fix or reference?

Fixes:

Merge requirements satisfied?

[NOTICE] Bug fixes or features added to Salt require tests.

Commits signed with GPG?

Yes? I think?

Please review Salt's Contributing Guide for best practices.

See GitHub's page on GPG signing for more information about signing commits with GPG.

@barbaricyawps barbaricyawps requested a review from a team as a code owner October 7, 2020 17:21
@ghost ghost requested review from DmitryKuzmenko and removed request for a team October 7, 2020 17:21
@sagetherage sagetherage added the Documentation Relates to Salt documentation label Oct 7, 2020
dwoz
dwoz previously approved these changes Oct 8, 2020
Copy link
Contributor

@ScriptAutomate ScriptAutomate left a comment

Choose a reason for hiding this comment

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

This looks great to me. The broken tests are unrelated, though.

Can we get final review and sign-off by @dwoz and @garethgreenaway ? And then override the passing tests requirements? I've pulled locally and built, and it looks fine.

git fetch upstream pull/58664/head:pr58664
git checkout pr58664

# Passes nox docs build
nox -e 'docs-html(compress=False, clean=True)'

# Renders great
firefox doc/_build/html/topics/salt_system_architecture.html

It also is tagged for easy reference from other docs in the repo, and appears toward the top in the index / TOC.

@dwoz dwoz merged commit d3606be into saltstack:master Dec 10, 2020
@sagetherage sagetherage added the Aluminium Release Post Mg and Pre Si label Feb 18, 2021
@barbaricyawps barbaricyawps deleted the rev_intro_to_salt branch September 1, 2022 20:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Aluminium Release Post Mg and Pre Si Documentation Relates to Salt documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants