PaloAltoNetworks / PaloAltoNetworks/docusaurus-openapi-docs

Update to let users set the base URL globally

Open
#760 2 comments 1 reaction 1 assignee View on GitHub

@blindaa121 is already working on this.

Since Jun 28, 2024.

enhancement roadmap
Dominant language
TypeScript
Stars
1.1k
Forks
315
Avg merge
7d 5h
Merged PRs (30d)
7

Description

Is your feature request related to a problem? No

I know the base URL can be changed by clicking edit, but it's not obvious. I want to request that users can change the base URL globally or make the highlighted area a drop down.
During testing, the main issue that came up was people didn't understand they could change the URL and kept asking how to change it.

Screenshot 2024-03-20 at 4 14 25 PM
Describe the solution you'd like

Ability to change the base URL at the top so it's more obvious there are more URLs available
Add it to the menu.

Describe alternatives you've considered

N/A

Additional context
  • Reduce users asking about the correct URL when viewing an endpoint.

Example showing how the URL is presented at at the top of the page.

Screenshot 2024-03-20 at 4 26 41 PM

Some options for the plugin:

  • Add it as a menu item
  • Add it to the introduction
  • Make it into a dropdown on each endpoint (preferred since it takes up a lot of real-estate versus the edit for the try it now.)
  • Set it globally at the introduction (Also preferred. See image above for example).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.