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

Add Getting Started Guide #925

Merged
merged 15 commits into from
Feb 8, 2024
Merged

Conversation

thom-at-redhat
Copy link
Contributor

No description provided.

Copy link

codecov bot commented Jan 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (9f05dd2) 36.57% compared to head (6f5149f) 36.39%.

@@            Coverage Diff             @@
##            devel     #925      +/-   ##
==========================================
- Coverage   36.57%   36.39%   -0.18%     
==========================================
  Files          42       42              
  Lines        7878     7878              
==========================================
- Hits         2881     2867      -14     
- Misses       4826     4838      +12     
- Partials      171      173       +2     

see 5 files with indirect coverage changes

@thom-at-redhat thom-at-redhat marked this pull request as ready for review January 17, 2024 13:57
Copy link
Contributor

@samccann samccann left a comment

Choose a reason for hiding this comment

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

Thanks for adding this guide!

Beyond the suggestions here, you need to add the new guide to source/index.rst. I suggest right after the install:
getting_started_guide/index

Then one of the CI tests will show readthedocs and if you click details, it will give you a preview of your docs. Very helpful to see it visually and pick up any stray problems.

docs/source/getting_started_guide/installing_receptor.rst Outdated Show resolved Hide resolved
docs/source/user_guide/basic_usage.rst Outdated Show resolved Hide resolved
docs/source/user_guide/basic_usage.rst Outdated Show resolved Hide resolved
docs/source/user_guide/connecting_nodes.rst Outdated Show resolved Hide resolved
docs/source/user_guide/interacting_with_nodes.rst Outdated Show resolved Hide resolved
docs/source/user_guide/interacting_with_nodes.rst Outdated Show resolved Hide resolved
docs/source/index.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@samccann samccann left a comment

Choose a reason for hiding this comment

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

we can now see the preview in the ci tests, so here's a few more items to fix.

There is a strange problem where if I click the user guide in the preview site, the getting started guide disappears... let's see what happens after fixing these few nits.

docs/source/getting_started_guide/index.rst Outdated Show resolved Hide resolved
docs/source/getting_started_guide/index.rst Outdated Show resolved Hide resolved
docs/source/getting_started_guide/installing_receptor.rst Outdated Show resolved Hide resolved
docs/source/getting_started_guide/installing_receptor.rst Outdated Show resolved Hide resolved
docs/source/getting_started_guide/index.rst Show resolved Hide resolved
docs/source/getting_started_guide/glossary.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@samccann samccann left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@AaronH88 AaronH88 left a comment

Choose a reason for hiding this comment

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

lgtm

Copy link

sonarcloud bot commented Feb 8, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@thom-at-redhat thom-at-redhat merged commit c24526b into ansible:devel Feb 8, 2024
15 checks passed
@thom-at-redhat thom-at-redhat deleted the add_gsg branch February 8, 2024 16:33
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.

3 participants