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

DOC: doc update #6

Merged
merged 2 commits into from
Dec 13, 2024
Merged

DOC: doc update #6

merged 2 commits into from
Dec 13, 2024

Conversation

anish-mudaraddi
Copy link
Collaborator

updating docs - remove mention of enums in user-docs to favor strings
adding extra string aliases for presets

Copy link

codecov bot commented Dec 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.55%. Comparing base (33278fc) to head (2181c84).
Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main       #6   +/-   ##
=======================================
  Coverage   99.55%   99.55%           
=======================================
  Files         111      111           
  Lines        4244     4244           
=======================================
  Hits         4225     4225           
  Misses         19       19           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

docs/developer_docs/ADDING_NEW_QUERIES.md Outdated Show resolved Hide resolved
docs/developer_docs/OVERVIEW.md Outdated Show resolved Hide resolved
docs/user_docs/API.md Show resolved Hide resolved
docs/user_docs/API.md Outdated Show resolved Hide resolved
docs/user_docs/query_docs/HYPERVISORS.md Show resolved Hide resolved
docs/user_docs/query_docs/IMAGES.md Outdated Show resolved Hide resolved
docs/user_docs/query_docs/PROJECTS.md Outdated Show resolved Hide resolved
docs/user_docs/query_docs/SERVERS.md Show resolved Hide resolved
docs/user_docs/query_docs/SERVERS.md Outdated Show resolved Hide resolved
docs/user_docs/query_docs/USERS.md Outdated Show resolved Hide resolved
@anish-mudaraddi anish-mudaraddi force-pushed the doc-update branch 2 times, most recently from f8f561d to 18b0165 Compare December 11, 2024 16:12
gmatthews20
gmatthews20 previously approved these changes Dec 11, 2024
Copy link
Member

@khalford khalford left a comment

Choose a reason for hiding this comment

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

Rather than adding many comments:

Some paths have a leading forward slash like:
/openstack/enums/...
Other paths do not have a leading forward slash:
openstack/enums/...

Which way is correct?

docs/developer_docs/OVERVIEW.md Outdated Show resolved Hide resolved
@anish-mudaraddi
Copy link
Collaborator Author

@khalford tere's no difference - its just a path - I'll remove the leading / since its more correct

updating docs - remove mention of enums in user-docs to favor strings - makes it easier to use
remove leading / on paths
@gmatthews20 gmatthews20 merged commit f7ac12d into main Dec 13, 2024
13 checks passed
@gmatthews20 gmatthews20 deleted the doc-update branch December 13, 2024 09:46
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.

3 participants