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.

Sign up for GitHub

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

Jump to bottom

Where is the documentation? #357

Closed
howardjones opened this issue Dec 9, 2020 · 4 comments
Closed

Where is the documentation? #357

howardjones opened this issue Dec 9, 2020 · 4 comments
Labels
medium_priority Medium priority work in In trying to solve, or in working with contributors

Comments

@howardjones
Copy link
Contributor

SUMMARY

"Did you know the documentation has an "Edit on GitHub" link on every page ?"
There is no link to documentation in the README.md (and therefore the Galaxy page).

(I was actually looking for guidance on using this collection with awx, which is causing me problems with dependencies)

ISSUE TYPE
  • Documentation Report
COMPONENT NAME
ANSIBLE VERSION
@Fred-sun
Copy link
Collaborator

@howardjones Thank you for your interest in this repo. Can you elaborate on the problem you encountered? I am not sure what kind of problem you have encountered? Thank you!

@Fred-sun Fred-sun added medium_priority Medium priority work in In trying to solve, or in working with contributors labels Dec 21, 2020
@howardjones
Copy link
Contributor Author

Sure! Go to the front page of this github repository. There is no link to any documentation. There is a "Contributing" item for reviewing the documentation, but no documentation.

Go to the Galaxy page for this collection, and there is just a copy of the README, so also no documentation.

The "website" link on the the Galaxy page just goes to the front of azure.microsoft.com

@Fred-sun
Copy link
Collaborator

Do you want get ansible doc info?

https://docs.ansible.com/ansible/latest/index.html

howardjones added a commit to howardjones/azure that referenced this issue Dec 22, 2020
@howardjones
Update README to include a link to documentation
17a15ec 
Linking to the docs in the README (ansible-collections#357 )
@howardjones howardjones mentioned this issue Dec 22, 2020
Merged
haiyuazhang added a commit that referenced this issue Dec 22, 2020
@howardjones @haiyuazhang
Update README to include a link to documentation (#376)
2d8e96d 
Linking to the docs in the README (#357 )

Co-authored-by: haiyuan_zhang <haiyuan.zhang1982@gmail.com>
@haiyuazhang
Copy link
Contributor

Has been fixed in PR376.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
medium_priority Medium priority work in In trying to solve, or in working with contributors
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@howardjones @haiyuazhang @Fred-sun