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

Restore community ee content #1852

Merged
merged 5 commits into from
Sep 11, 2024
Merged

Conversation

oraNod
Copy link
Contributor

@oraNod oraNod commented Sep 10, 2024

This PR restores the docs about community execution environments from the ecosystem docsite. Please see the forum post for more info about this change: https://forum.ansible.com/t/moving-the-community-ee-content-to-package-docs/8239

This PR restores the docs about community execution environments from
the ecosystem docsite. Please see the forum post for more info about
this change: https://forum.ansible.com/t/moving-the-community-ee-content-to-package-docs/8239
@oraNod oraNod added DaWGs Good discussion item for the DaWGs backport-2.15 Automatically create a backport for the stable-2.15 branch backport-2.16 Automatically create a backport for the stable-2.16 branch backport-2.17 Automatically create a backport for the stable-2.17 branch labels Sep 10, 2024
@oraNod
Copy link
Contributor Author

oraNod commented Sep 10, 2024

This builds for the package docs only, not core docs. I've kicked off a build that will deploy to the test site -> https://github.com/ansible/ansible-documentation/actions/runs/10791538997

@Andersson007 FYI ^

@Andersson007
Copy link
Contributor

@oraNod does the PR just move the content from the old location unchanged? If yes, shipit

@oraNod
Copy link
Contributor Author

oraNod commented Sep 10, 2024

@oraNod does the PR just move the content from the old location unchanged? If yes, shipit

@Andersson007 There is one minor change. I took out the cat ... EOF wrapper for the yaml examples and put them in as native file type. I think it's better so we can lint the yaml files. For instance I found a spacing error and Ansible lint caught the truthy rule violation s/become: yes/become:true.

Copy link
Contributor

@Andersson007 Andersson007 left a comment

Choose a reason for hiding this comment

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

LGTM

@oraNod
Copy link
Contributor Author

oraNod commented Sep 10, 2024

Thanks @Andersson007 Here are the package docs on the stage / test site now: https://ansible-community.github.io/package-doc-builds/getting_started_ee/index.html

Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>
Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>
Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>
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. I'd also remove the 2.15 packport. That equates to Ansible 8 which is EOL.

@samccann samccann removed the DaWGs Good discussion item for the DaWGs label Sep 10, 2024
@oraNod
Copy link
Contributor Author

oraNod commented Sep 10, 2024

LGTM. I'd also remove the 2.15 packport. That equates to Ansible 8 which is EOL.

Thanks @samccann that makes sense to me but I'll defer to @Andersson007 there. Cheers.

@Andersson007
Copy link
Contributor

Andersson007 commented Sep 11, 2024

LGTM, about 2.15: according to the doc it'll be EOL in November . Let's leave it then Ah, i see now you're talking about the package, not sure then. I think i would still backport to supported core branches as if we don't, it could lead to more merge conflicts as sometimes core-specific pages correlates with more general pages

@Andersson007 Andersson007 merged commit 2043e2e into ansible:devel Sep 11, 2024
9 checks passed
Copy link

patchback bot commented Sep 11, 2024

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

❌ Failed to cleanly apply 2043e2e on top of patchback/backports/stable-2.15/2043e2efa0de69f39edee2829934ca141fd1f254/pr-1852

Backporting merged PR #1852 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.15/2043e2efa0de69f39edee2829934ca141fd1f254/pr-1852 upstream/stable-2.15
  4. Now, cherry-pick PR Restore community ee content #1852 contents into that branch:
    $ git cherry-pick -x 2043e2efa0de69f39edee2829934ca141fd1f254
    If it'll yell at you with something like fatal: Commit 2043e2efa0de69f39edee2829934ca141fd1f254 is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x 2043e2efa0de69f39edee2829934ca141fd1f254
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR Restore community ee content #1852 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/stable-2.15/2043e2efa0de69f39edee2829934ca141fd1f254/pr-1852
  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.

Copy link

patchback bot commented Sep 11, 2024

Backport to stable-2.16: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2.16/2043e2efa0de69f39edee2829934ca141fd1f254/pr-1852

Backported as #1858

🤖 @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 Sep 11, 2024
* restore community ee content

This PR restores the docs about community execution environments from
the ecosystem docsite. Please see the forum post for more info about
this change: https://forum.ansible.com/t/moving-the-community-ee-content-to-package-docs/8239

* Update docs/docsite/rst/getting_started_ee/introduction.rst

Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>

* Update docs/docsite/rst/getting_started_ee/introduction.rst

Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>

* Update docs/docsite/rst/getting_started_ee/run_community_ee_image.rst

Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>

* formatting nits

---------

Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>
(cherry picked from commit 2043e2e)
Copy link

patchback bot commented Sep 11, 2024

Backport to stable-2.17: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2.17/2043e2efa0de69f39edee2829934ca141fd1f254/pr-1852

Backported as #1859

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

@Andersson007
Copy link
Contributor

@oraNod thanks for moving the docs back! @samccann thanks for reviewing!

patchback bot pushed a commit that referenced this pull request Sep 11, 2024
* restore community ee content

This PR restores the docs about community execution environments from
the ecosystem docsite. Please see the forum post for more info about
this change: https://forum.ansible.com/t/moving-the-community-ee-content-to-package-docs/8239

* Update docs/docsite/rst/getting_started_ee/introduction.rst

Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>

* Update docs/docsite/rst/getting_started_ee/introduction.rst

Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>

* Update docs/docsite/rst/getting_started_ee/run_community_ee_image.rst

Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>

* formatting nits

---------

Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>
(cherry picked from commit 2043e2e)
oraNod added a commit that referenced this pull request Sep 11, 2024
* restore community ee content

This PR restores the docs about community execution environments from
the ecosystem docsite. Please see the forum post for more info about
this change: https://forum.ansible.com/t/moving-the-community-ee-content-to-package-docs/8239

* Update docs/docsite/rst/getting_started_ee/introduction.rst

Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>

* Update docs/docsite/rst/getting_started_ee/introduction.rst

Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>

* Update docs/docsite/rst/getting_started_ee/run_community_ee_image.rst

Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>

* formatting nits

---------

Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>
(cherry picked from commit 2043e2e)

Co-authored-by: Don Naro <dnaro@redhat.com>
oraNod added a commit that referenced this pull request Sep 11, 2024
#1858)

* Restore community ee content (#1852)

* restore community ee content

This PR restores the docs about community execution environments from
the ecosystem docsite. Please see the forum post for more info about
this change: https://forum.ansible.com/t/moving-the-community-ee-content-to-package-docs/8239

* Update docs/docsite/rst/getting_started_ee/introduction.rst

Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>

* Update docs/docsite/rst/getting_started_ee/introduction.rst

Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>

* Update docs/docsite/rst/getting_started_ee/run_community_ee_image.rst

Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>

* formatting nits

---------

Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>
(cherry picked from commit 2043e2e)

* add file to exclude list

---------

Co-authored-by: Don Naro <dnaro@redhat.com>
@oraNod
Copy link
Contributor Author

oraNod commented Sep 11, 2024

The backport to stable-2.15 failed because I don't think the content ever existed on that branch. So let's leave it. It's backported to 2.17 and 2.16 now. We should be good. Thanks again.

oraNod added a commit that referenced this pull request Nov 25, 2024
* restore community ee content

This PR restores the docs about community execution environments from
the ecosystem docsite. Please see the forum post for more info about
this change: https://forum.ansible.com/t/moving-the-community-ee-content-to-package-docs/8239

* Update docs/docsite/rst/getting_started_ee/introduction.rst

Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>

* Update docs/docsite/rst/getting_started_ee/introduction.rst

Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>

* Update docs/docsite/rst/getting_started_ee/run_community_ee_image.rst

Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>

* formatting nits

---------

Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-2.15 Automatically create a backport for the stable-2.15 branch backport-2.16 Automatically create a backport for the stable-2.16 branch backport-2.17 Automatically create a backport for the stable-2.17 branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants