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

Move Dev Guide to collection #330

Merged
merged 3 commits into from
May 9, 2022
Merged

Move Dev Guide to collection #330

merged 3 commits into from
May 9, 2022

Conversation

mariolenz
Copy link
Collaborator

@mariolenz mariolenz commented May 6, 2022 •
edited
Loading

Depends-On: #331

SUMMARY

Collection-specific docs must move to their collections.

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

docsite

ADDITIONAL INFORMATION

see here

cc @samccann

@softwarefactory-project-zuul
Copy link
Contributor

Build failed.

✔️ build-ansible-collection SUCCESS in 4m 38s
❌ ansible-tox-linters FAILURE in 4m 51s
❌ ansible-test-sanity-docker-devel FAILURE in 10m 46s (non-voting)
❌ ansible-test-sanity-docker-milestone FAILURE in 8m 20s
✔️ ansible-test-sanity-docker-stable-2.9 SUCCESS in 10m 35s
✔️ ansible-test-sanity-docker-stable-2.11 SUCCESS in 10m 15s
✔️ ansible-test-sanity-docker-stable-2.12 SUCCESS in 8m 42s
✔️ ansible-galaxy-importer SUCCESS in 4m 24s

@mariolenz
Copy link
Collaborator Author

Any idea why the CI fails with ./docs/docsite/rst/dev_guide.rst:56:0: (ERROR/3) Unknown interpreted text role "file"? There wasn't a problem in ansible/ansible.

@Akasurde
Copy link
Member

Akasurde commented May 6, 2022

Any idea why the CI fails with ./docs/docsite/rst/dev_guide.rst:56:0: (ERROR/3) Unknown interpreted text role "file"? There wasn't a problem in ansible/ansible.

I think this line is causing error - https://github.com/ansible-collections/vmware.vmware_rest/pull/330/files#diff-0b510edc985da022dbbc809c141a2cce98c926d0f44c61533792248231bffdbbR56

Not sure why.

@mariolenz @Akasurde
Github -> GitHub
1b6ca2f 
Co-authored-by: Abhijeet Kasurde <[email protected]>
@softwarefactory-project-zuul
Copy link
Contributor

Build failed.

✔️ build-ansible-collection SUCCESS in 4m 39s
❌ ansible-tox-linters FAILURE in 5m 21s
❌ ansible-test-sanity-docker-devel FAILURE in 12m 11s (non-voting)
❌ ansible-test-sanity-docker-milestone FAILURE in 10m 51s
✔️ ansible-test-sanity-docker-stable-2.9 SUCCESS in 13m 45s
✔️ ansible-test-sanity-docker-stable-2.11 SUCCESS in 9m 24s
✔️ ansible-test-sanity-docker-stable-2.12 SUCCESS in 8m 52s
✔️ ansible-galaxy-importer SUCCESS in 4m 39s

@softwarefactory-project-zuul
Copy link
Contributor

Build failed.

✔️ build-ansible-collection SUCCESS in 4m 55s
✔️ ansible-tox-linters SUCCESS in 4m 35s
❌ ansible-test-sanity-docker-devel FAILURE in 11m 01s (non-voting)
❌ ansible-test-sanity-docker-milestone FAILURE in 9m 43s
✔️ ansible-test-sanity-docker-stable-2.9 SUCCESS in 12m 03s
✔️ ansible-test-sanity-docker-stable-2.11 SUCCESS in 9m 16s
✔️ ansible-test-sanity-docker-stable-2.12 SUCCESS in 9m 35s
✔️ ansible-galaxy-importer SUCCESS in 5m 12s

@mariolenz
Copy link
Collaborator Author

@Akasurde I've removed the offending :file:, although I'm not really sure what this implies.

But these failures don't look related to my changes:

2022-05-06 08:42:05.407596 | controller | ERROR: Found 24 validate-modules issue(s) which need to be resolved:
2022-05-06 08:42:05.407702 | controller | ERROR: plugins/lookup/cluster_moid.py:0:0: invalid-documentation: DOCUMENTATION.author: Invalid author for dictionary value @ data['author']. Got ['Alina Buzachis <@alinabuzachis>']
2022-05-06 08:42:05.407775 | controller | ERROR: plugins/lookup/cluster_moid.py:0:0: invalid-documentation: DOCUMENTATION.lookup: extra keys not allowed @ data['lookup']. Got 'cluster_moid'
2022-05-06 08:42:05.407828 | controller | ERROR: plugins/lookup/cluster_moid.py:0:0: invalid-documentation: DOCUMENTATION.name: required key not provided @ data['name']. Got None
2022-05-06 08:42:05.407886 | controller | ERROR: plugins/lookup/datacenter_moid.py:0:0: invalid-documentation: DOCUMENTATION.author: Invalid author for dictionary value @ data['author']. Got ['Alina Buzachis <@alinabuzachis>']
2022-05-06 08:42:05.407935 | controller | ERROR: plugins/lookup/datacenter_moid.py:0:0: invalid-documentation: DOCUMENTATION.lookup: extra keys not allowed @ data['lookup']. Got 'datacenter_moid'
2022-05-06 08:42:05.407985 | controller | ERROR: plugins/lookup/datacenter_moid.py:0:0: invalid-documentation: DOCUMENTATION.name: required key not provided @ data['name']. Got None
2022-05-06 08:42:05.408039 | controller | ERROR: plugins/lookup/datastore_moid.py:0:0: invalid-documentation: DOCUMENTATION.author: Invalid author for dictionary value @ data['author']. Got ['Alina Buzachis <@alinabuzachis>']
2022-05-06 08:42:05.408087 | controller | ERROR: plugins/lookup/datastore_moid.py:0:0: invalid-documentation: DOCUMENTATION.lookup: extra keys not allowed @ data['lookup']. Got 'datastore_moid'
2022-05-06 08:42:05.408169 | controller | ERROR: plugins/lookup/datastore_moid.py:0:0: invalid-documentation: DOCUMENTATION.name: required key not provided @ data['name']. Got None
2022-05-06 08:42:05.408224 | controller | ERROR: plugins/lookup/folder_moid.py:0:0: invalid-documentation: DOCUMENTATION.author: Invalid author for dictionary value @ data['author']. Got ['Alina Buzachis <@alinabuzachis>']
2022-05-06 08:42:05.408273 | controller | ERROR: plugins/lookup/folder_moid.py:0:0: invalid-documentation: DOCUMENTATION.lookup: extra keys not allowed @ data['lookup']. Got 'folder_moid'
2022-05-06 08:42:05.408323 | controller | ERROR: plugins/lookup/folder_moid.py:0:0: invalid-documentation: DOCUMENTATION.name: required key not provided @ data['name']. Got None
2022-05-06 08:42:05.408378 | controller | ERROR: plugins/lookup/host_moid.py:0:0: invalid-documentation: DOCUMENTATION.author: Invalid author for dictionary value @ data['author']. Got ['Alina Buzachis <@alinabuzachis>']
2022-05-06 08:42:05.408426 | controller | ERROR: plugins/lookup/host_moid.py:0:0: invalid-documentation: DOCUMENTATION.lookup: extra keys not allowed @ data['lookup']. Got 'host_moid'
2022-05-06 08:42:05.408475 | controller | ERROR: plugins/lookup/host_moid.py:0:0: invalid-documentation: DOCUMENTATION.name: required key not provided @ data['name']. Got None
2022-05-06 08:42:05.408529 | controller | ERROR: plugins/lookup/network_moid.py:0:0: invalid-documentation: DOCUMENTATION.author: Invalid author for dictionary value @ data['author']. Got ['Alina Buzachis <@alinabuzachis>']
2022-05-06 08:42:05.408577 | controller | ERROR: plugins/lookup/network_moid.py:0:0: invalid-documentation: DOCUMENTATION.lookup: extra keys not allowed @ data['lookup']. Got 'network_moid'
2022-05-06 08:42:05.408626 | controller | ERROR: plugins/lookup/network_moid.py:0:0: invalid-documentation: DOCUMENTATION.name: required key not provided @ data['name']. Got None
2022-05-06 08:42:05.408679 | controller | ERROR: plugins/lookup/resource_pool_moid.py:0:0: invalid-documentation: DOCUMENTATION.author: Invalid author for dictionary value @ data['author']. Got ['Alina Buzachis <@alinabuzachis>']
2022-05-06 08:42:05.408728 | controller | ERROR: plugins/lookup/resource_pool_moid.py:0:0: invalid-documentation: DOCUMENTATION.lookup: extra keys not allowed @ data['lookup']. Got 'resource_pool_moid'
2022-05-06 08:42:05.408777 | controller | ERROR: plugins/lookup/resource_pool_moid.py:0:0: invalid-documentation: DOCUMENTATION.name: required key not provided @ data['name']. Got None
2022-05-06 08:42:05.408830 | controller | ERROR: plugins/lookup/vm_moid.py:0:0: invalid-documentation: DOCUMENTATION.author: Invalid author for dictionary value @ data['author']. Got ['Alina Buzachis <@alinabuzachis>']
2022-05-06 08:42:05.408878 | controller | ERROR: plugins/lookup/vm_moid.py:0:0: invalid-documentation: DOCUMENTATION.lookup: extra keys not allowed @ data['lookup']. Got 'vm_moid'
2022-05-06 08:42:05.408931 | controller | ERROR: plugins/lookup/vm_moid.py:0:0: invalid-documentation: DOCUMENTATION.name: required key not provided @ data['name']. Got None
2022-05-06 08:42:05.409219 | controller | See documentation for help: https://docs.ansible.com/ansible-core/devel/dev_guide/testing/sanity/validate-modules.html

@Akasurde
Copy link
Member

Akasurde commented May 6, 2022

Yes, this is related to docs in the lookup plugin plugins/lookup/

cc @alinabuzachis

@mariolenz
Copy link
Collaborator Author

Yes, this is related to docs in the lookup plugin plugins/lookup/

Yes, you're right! I think sanity testing lookup plugins is quite new, so that's why it didn't fail previously. I think I know what the problem is here, let me try something.

@alinabuzachis
Copy link
Collaborator

@mariolenz Oh, let me know if I can do something and give it a try! Thank you.

@mariolenz
Copy link
Collaborator Author

@Akasurde @alinabuzachis Let's see if #331 helps.

@mariolenz
Copy link
Collaborator Author

recheck

@softwarefactory-project-zuul
Copy link
Contributor

Build succeeded.

✔️ build-ansible-collection SUCCESS in 4m 35s
✔️ ansible-tox-linters SUCCESS in 5m 15s
✔️ ansible-test-sanity-docker-devel SUCCESS in 9m 50s (non-voting)
✔️ ansible-test-sanity-docker-milestone SUCCESS in 10m 06s
✔️ ansible-test-sanity-docker-stable-2.9 SUCCESS in 14m 37s
✔️ ansible-test-sanity-docker-stable-2.11 SUCCESS in 9m 08s
✔️ ansible-test-sanity-docker-stable-2.12 SUCCESS in 10m 06s
✔️ ansible-galaxy-importer SUCCESS in 4m 48s

@mariolenz mariolenz requested a review from Akasurde May 6, 2022 17:49
@mariolenz
Copy link
Collaborator Author

@Akasurde Could you please have a look at this PR again?

@mariolenz mariolenz mentioned this pull request May 7, 2022
Closed
7 tasks
@mariolenz mariolenz added documentation Improvements or additions to documentation docs labels May 8, 2022
samccann
samccann approved these changes May 9, 2022
View reviewed changes
Copy link

@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 and thanks for moving this over!

@mariolenz mariolenz removed the request for review from Akasurde May 9, 2022 15:00
@mariolenz mariolenz added mergeit and removed mergeit labels May 9, 2022
@softwarefactory-project-zuul
Copy link
Contributor

Build succeeded (gate pipeline).

✔️ build-ansible-collection SUCCESS in 4m 50s
✔️ ansible-tox-linters SUCCESS in 5m 01s
✔️ ansible-test-sanity-docker-devel SUCCESS in 9m 12s (non-voting)
✔️ ansible-test-sanity-docker-milestone SUCCESS in 10m 42s
✔️ ansible-test-sanity-docker-stable-2.9 SUCCESS in 10m 24s
✔️ ansible-test-sanity-docker-stable-2.11 SUCCESS in 8m 47s
✔️ ansible-test-sanity-docker-stable-2.12 SUCCESS in 9m 36s
✔️ ansible-galaxy-importer SUCCESS in 3m 51s

@softwarefactory-project-zuul softwarefactory-project-zuul bot merged commit cf52640 into ansible-collections:main May 9, 2022
@mariolenz mariolenz deleted the move_dev_guide branch May 9, 2022 15:38
@mariolenz mariolenz mentioned this pull request Jul 13, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Akasurde Akasurde Akasurde left review comments

@samccann samccann samccann approved these changes

Assignees
No one assigned
Labels
docs documentation Improvements or additions to documentation mergeit
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@mariolenz @Akasurde @alinabuzachis @samccann