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

Point EE getting started to ecosystem #617

Merged
merged 5 commits into from
Oct 25, 2023

Conversation

oraNod
Copy link
Contributor

@oraNod oraNod commented Oct 16, 2023

Related to ansible/ecosystem-documentation#4

This PR updates the EE getting started guide to:

  • Keep the index as part of the package docs
  • Orphan all the other pages in getting started with EEs. We should remove these before merging on to latest / stable-2.16.
  • Direct users to the Ansible ecosystem docsite

@oraNod oraNod requested a review from Andersson007 October 16, 2023 11:54
@github-actions github-actions bot added the needs_triage Needs a first human triage before being processed. label Oct 16, 2023
@oraNod oraNod force-pushed the ee-start-ecosystem branch from b7869af to d953d74 Compare October 17, 2023 17:17
@oraNod
Copy link
Contributor Author

oraNod commented Oct 17, 2023

@Andersson007 and @samccann Please remind me if the :orphan: tag is really necessary in the index page? https://github.com/ansible/ansible-documentation/blame/d953d74ef11480e4138f7075a2a0ab8d336c7afa/docs/docsite/rst/getting_started_ee/index.rst#L1

This is excluded from the core docs so I don't think we really need :orphan: . Or am I losing my mind?

@samccann
Copy link
Contributor

:orphan: is for any file that doesn't appear in the index/toc. I 'think' you are correct that it's not needed in that file, but try building core and package docs locally to be sure...

@samccann
Copy link
Contributor

I didn't slap a label on this yet but I think this has to backport to 2.16 right?

@Andersson007
Copy link
Contributor

approved. though i would prefer to see ultimately if people use the URLs, they will be redirected to the ecosystem (w/o a need to click here and there). not sure if it's feasible though

@oraNod oraNod added backport-2.16 Automatically create a backport for the stable-2.16 branch and removed needs_triage Needs a first human triage before being processed. labels Oct 19, 2023
@oraNod oraNod force-pushed the ee-start-ecosystem branch from d953d74 to 7e30142 Compare October 19, 2023 11:01
@oraNod oraNod temporarily deployed to github-bot October 19, 2023 11:01 — with GitHub Actions Inactive
@oraNod
Copy link
Contributor Author

oraNod commented Oct 19, 2023

:orphan: is for any file that doesn't appear in the index/toc. I 'think' you are correct that it's not needed in that file, but try building core and package docs locally to be sure...

yeah I tried with coredocs yesterday and it was fine. gave it another shot with webdocs and coredocs. works on my machine so I removed the orphan tag from the index page.

@oraNod oraNod temporarily deployed to github-bot October 19, 2023 11:04 — with GitHub Actions Inactive
@oraNod
Copy link
Contributor Author

oraNod commented Oct 19, 2023

@Andersson007 I set up the redirects (ansible/docsite#187) so we don't need to keep the stub/orphan pages around. I went ahead and removed them as part of this PR. I left the index in place because it seems weird without that and I'm not really sure yet if we want to redirect the index. PTAL

@Andersson007
Copy link
Contributor

@Andersson007 I set up the redirects (ansible/docsite#187) so we don't need to keep the stub/orphan pages around. I went ahead and removed them as part of this PR. I left the index in place because it seems weird without that and I'm not really sure yet if we want to redirect the index. PTAL

@oraNod that's great, approved, thanks!

@oraNod oraNod merged commit ebe3578 into ansible:devel Oct 25, 2023
7 checks passed
@patchback
Copy link

patchback bot commented Oct 25, 2023

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

❌ Failed to cleanly apply ebe3578 on top of patchback/backports/stable-2.16/ebe3578d7d2057196755b2985885b802dd5fc353/pr-617

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

@oraNod
Copy link
Contributor Author

oraNod commented Oct 25, 2023

Thanks @Andersson007 and @samccann

oraNod added a commit to oraNod/ansible-documentation that referenced this pull request Oct 25, 2023
* ee getting started points to ecosystem
* fix rst error with new line
* add more specific links to ecosystem pages
* remove orphan tag from index
* rm orphaned pages to rely on redirects
oraNod added a commit that referenced this pull request Oct 25, 2023
* Point EE getting started to ecosystem (#617)

* ee getting started points to ecosystem
* fix rst error with new line
* add more specific links to ecosystem pages
* remove orphan tag from index
* rm orphaned pages to rely on redirects

* update urls for getting started with ees
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-2.16 Automatically create a backport for the stable-2.16 branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants