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

Docs for ISO generation are missing optional properties #7360

Open
ocket8888 opened this issue Feb 22, 2023 · 3 comments
Open

Docs for ISO generation are missing optional properties #7360

ocket8888 opened this issue Feb 22, 2023 · 3 comments
Labels
bug something isn't working as intended documentation related to documentation good first issue first-time committers will find this easy to resolve low difficulty the estimated level of effort to resolve this issue is low low impact affects only a small portion of a CDN, and cannot itself break one

Comments

@ocket8888
Copy link
Contributor

This Bug Report affects these Traffic Control components:

  • Documentation

Current behavior:

The docs for the /isos TO API endpoint in all versions are missing descriptions for the following optional request properties:

  • mgmtIpAddress - management interface IP address
  • mgmtIpNetmask - management interface IP netmask
  • mgmtIpGateway - management interface gateway IP address
  • mgmtInterface - management interface network interface device name

Expected behavior:

Documentation should be complete and accurate.

Steps to reproduce:

Read the docs
@ocket8888 ocket8888 added bug something isn't working as intended documentation related to documentation low impact affects only a small portion of a CDN, and cannot itself break one good first issue first-time committers will find this easy to resolve low difficulty the estimated level of effort to resolve this issue is low labels Feb 22, 2023
@Exar04
Copy link

Exar04 commented Feb 27, 2023

hey can i work on this. I am new to OS. Where do i start? Reading the docs and then?

@ocket8888
Copy link
Contributor Author

Our documentation lives under doc/source/ and can be built using make from within doc/ (see the documentation section on building the documentation). The API documentation is in docs/source/api/ which has subdirectories for each API version (v3, v4, and v5) which each contain a file describing the /isos endpoint that is missing the above property descriptions.

@Exar04 Exar04 removed their assignment Mar 31, 2023
@AdityaMayukhSom
Copy link

As no one else is currently working on this, I have started working on the issue. Will open a PR soon.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug something isn't working as intended documentation related to documentation good first issue first-time committers will find this easy to resolve low difficulty the estimated level of effort to resolve this issue is low low impact affects only a small portion of a CDN, and cannot itself break one
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@ocket8888 @AdityaMayukhSom @Exar04