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 EE docs #18

Merged
merged 35 commits into from
Jul 11, 2023
Merged

Add EE docs #18

merged 35 commits into from
Jul 11, 2023

Conversation

Andersson007
Copy link
Contributor

@oraNod
Copy link
Contributor

oraNod commented Jun 23, 2023

@Andersson007 I pushed a commit directly to your branch to get the structure as agreed at the docs meeting.

image

I also made a few edits and dropped the "terminology" section because I don't think it's that useful. TBH I found the terminology was a little confusing. Also I would assume people understand concepts like container runtimes and it's not the job of Ansible documentation to explain them.

@oraNod oraNod requested a review from samccann June 23, 2023 16:21
Copy link
Contributor

@oraNod oraNod left a comment

Choose a reason for hiding this comment

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

LGTM

@Andersson007
Copy link
Contributor Author

@samccann could you please take a look?

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.

give a writer a second chance to look at a file, and she'll find more things to comment on :-)

docs/docsite/rst/getting_started_ee/index.rst Show resolved Hide resolved
docs/docsite/rst/core_index.rst Outdated Show resolved Hide resolved
docs/docsite/rst/getting_started_ee/index.rst Outdated Show resolved Hide resolved
docs/docsite/rst/getting_started_ee/introduction.rst Outdated Show resolved Hide resolved
docs/docsite/rst/getting_started_ee/introduction.rst Outdated Show resolved Hide resolved
@Andersson007
Copy link
Contributor Author

@samccann all feedback is incorporated, PTAL

@samccann
Copy link
Contributor

Thanks. I'd like core approval first since this PR currrently adds the EE getting started guide to core docs as well.

@Andersson007
Copy link
Contributor Author

Thanks. I'd like core approval first since this PR currrently adds the EE getting started guide to core docs as well.

@sivel @nitzmahone PTAL #18 (comment)

This PR's waiting for your approval to get merged

@oraNod
Copy link
Contributor

oraNod commented Jul 10, 2023

@Andersson007 I added the orphan tag to suppress the toc-tree warning from sphinx. This is necessary if the index is not included in the main core index.

My vote is still on publishing this on devel only and discussing where to create more "ecosystem" docs.

In a previous comment I mentioned a separate ansible/ecosystem-documentation repo but additional repositories increases contributor overhead. I think a potential solution might be a structure in ansible/ansible-documentation like this:

docs/
├─ core/
│  ├─ rst/
│  │  ├─ index.rst
├─ ecosystem/
│  ├─ rst/
│  │  ├─ index.rst
├─ package/
│  ├─ rst/
│  │  ├─ index.rst

@oraNod oraNod requested a review from samccann July 10, 2023 11:31
@samccann
Copy link
Contributor

I think y'all are waiting on me for this one. Thanks for removing this from the core docs. There's one other step to take. Basically, anything 'excluded' from core (and the japanese core translation) means you also need to add any new files to the exclude section in the conf.py files:
https://github.com/ansible/ansible-documentation/blob/devel/docs/docsite/sphinx_conf/core_conf.py#L93
and
https://github.com/ansible/ansible-documentation/blob/devel/docs/docsite/sphinx_conf/core_lang_conf.py#L93

Or those two docsets will no longer build :-)

@Andersson007
Copy link
Contributor Author

I think y'all are waiting on me for this one. Thanks for removing this from the core docs. There's one other step to take. Basically, anything 'excluded' from core (and the japanese core translation) means you also need to add any new files to the exclude section in the conf.py files: https://github.com/ansible/ansible-documentation/blob/devel/docs/docsite/sphinx_conf/core_conf.py#L93 and https://github.com/ansible/ansible-documentation/blob/devel/docs/docsite/sphinx_conf/core_lang_conf.py#L93

Or those two docsets will no longer build :-)

@samccann done, thanks, PTAL

@oraNod
Copy link
Contributor

oraNod commented Jul 11, 2023

Discussed this one at the docs (DaWGs) meeting today (July 11, 2023). Agreement is to merge and keep this on the devel branch of the Ansible package docs until we establish an official home for the ecosystem docs. The layout that I suggested for ansible/ansible-documentation seems to be preferred over another, separate, docs repo. We'll see how that shakes out.

@oraNod oraNod merged commit 22d2029 into ansible:devel Jul 11, 2023
@oraNod
Copy link
Contributor

oraNod commented Jul 11, 2023

Thank you @Andersson007 Big +1 to all the work here. 🎉 🌮 🐙

@Andersson007
Copy link
Contributor Author

thanks everyone for your great help! Would've been impossible this to look as good as it's now without you!

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.

Determine location for the EE overview page and the Build and test first EE quickstart guide.
4 participants