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

Fix missing newline before a list #257

Merged
merged 1 commit into from
Aug 8, 2023

Conversation

CyrilBrulebois
Copy link
Contributor

Without it, all list items appear one after another within the paragraph that's supposed to be introducing them.

Without it, all list items appear one after another within the paragraph
that's supposed to be introducing them.
@github-actions github-actions bot added the needs_triage Needs a first human triage before being processed. label Aug 8, 2023
@CyrilBrulebois
Copy link
Contributor Author

I'm attaching a screenshot of the problematic paragraph. I haven't set up a build environment to build the whole ansible-documentation repository (yet) but I've verified that a manual rst2html generates a page where this specific issue goes away once the patch is applied.

missing-newline

@gotmax23 gotmax23 added backport-2.15 Automatically create a backport for the stable-2.15 branch backport-2.14 Automatically create a backport for the stable-2.14 branch backport-2.13 Automatically create a backport for the stable-2.13 branch labels Aug 8, 2023
@gotmax23
Copy link
Collaborator

gotmax23 commented Aug 8, 2023

Thanks for your Ansible docs contribution! We talk about Ansible documentation on matrix at #docs:ansible.im and on libera IRC at #ansible-docs if you ever want to join us and chat about the docs! We meet there on Tuesdays (see the Ansible calendar) and welcome additions to our weekly agenda items - scroll down to find the upcoming agenda and add a comment to put something new on that agenda.

@gotmax23 gotmax23 added the new_contributor This PR is the first contribution by a new community member. label Aug 8, 2023
@oraNod oraNod removed the needs_triage Needs a first human triage before being processed. label Aug 8, 2023
@oraNod oraNod merged commit 1f1f6cf into ansible:devel Aug 8, 2023
@patchback
Copy link

patchback bot commented Aug 8, 2023

Backport to stable-2.15: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2.15/1f1f6cf9791dfd79eb38de211797791924f01330/pr-257

Backported as #260

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

@oraNod
Copy link
Contributor

oraNod commented Aug 8, 2023

Thanks @CyrilBrulebois

patchback bot pushed a commit that referenced this pull request Aug 8, 2023
@patchback
Copy link

patchback bot commented Aug 8, 2023

Backport to stable-2.14: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2.14/1f1f6cf9791dfd79eb38de211797791924f01330/pr-257

Backported as #261

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

patchback bot pushed a commit that referenced this pull request Aug 8, 2023
@patchback
Copy link

patchback bot commented Aug 8, 2023

Backport to stable-2.13: 💔 cherry-picking failed — conflicts found

❌ Failed to cleanly apply 1f1f6cf on top of patchback/backports/stable-2.13/1f1f6cf9791dfd79eb38de211797791924f01330/pr-257

Backporting merged PR #257 into devel

  1. Ensure you have a local repo clone of your fork. Unless you cloned it
    from the upstream, this would be your origin remote.
  2. Make sure you have an upstream repo added as a remote too. In these
    instructions you'll refer to it by the name upstream. If you don't
    have it, here's how you can add it:
    $ git remote add upstream https://github.com/ansible/ansible-documentation.git
  3. Ensure you have the latest copy of upstream and prepare a branch
    that will hold the backported code:
    $ git fetch upstream
    $ git checkout -b patchback/backports/stable-2.13/1f1f6cf9791dfd79eb38de211797791924f01330/pr-257 upstream/stable-2.13
  4. Now, cherry-pick PR Fix missing newline before a list #257 contents into that branch:
    $ git cherry-pick -x 1f1f6cf9791dfd79eb38de211797791924f01330
    If it'll yell at you with something like fatal: Commit 1f1f6cf9791dfd79eb38de211797791924f01330 is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x 1f1f6cf9791dfd79eb38de211797791924f01330
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR Fix missing newline before a list #257 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/stable-2.13/1f1f6cf9791dfd79eb38de211797791924f01330/pr-257
  7. Create a PR, ensure that the CI is green. If it's not — update it so that
    the tests and any other checks pass. This is it!
    Now relax and wait for the maintainers to process your pull request
    when they have some cycles to do reviews. Don't worry — they'll tell you if
    any improvements are necessary when the time comes!

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

gotmax23 pushed a commit that referenced this pull request Aug 8, 2023
gotmax23 pushed a commit that referenced this pull request Aug 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-2.13 Automatically create a backport for the stable-2.13 branch backport-2.14 Automatically create a backport for the stable-2.14 branch backport-2.15 Automatically create a backport for the stable-2.15 branch new_contributor This PR is the first contribution by a new community member.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants