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

Update gui api #1198

Merged
merged 3 commits into from
Aug 30, 2023
Merged

Update gui api #1198

merged 3 commits into from
Aug 30, 2023

Conversation

hannaeko
Copy link
Member

Purpose

Update the documentation following the introduction of language in URL.

Context

zonemaster/zonemaster-gui#377

Changes

Add in all paths.

How to test this PR

N/A

@hannaeko hannaeko added A-Documentation Area: Documentation only. V-Patch Versioning: The change gives an update of patch in version. labels Aug 21, 2023
@hannaeko hannaeko linked an issue Aug 21, 2023 that may be closed by this pull request
ghost
ghost previously approved these changes Aug 21, 2023
Copy link
Contributor

@matsduf matsduf left a comment

Choose a reason for hiding this comment

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

It looks fine besides a missing detail.

The GUI will rewrite `<lang>/test/<test-id>` to `<lang>/result/<test-id>`
before the result is displayed.

The GUI will redirect from `<path>` to `<lang>/<path>` automatically.
Copy link
Contributor

Choose a reason for hiding this comment

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

It should be specified how <lang> is selected for this case.

Copy link
Member Author

Choose a reason for hiding this comment

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

I have clarified this section a bit more.

Comment on lines 28 to 30
The GUI will redirect from `<path>` to `<lang>/<path>` automatically using the
user browser language, defaulting to the default language defined in the
reverse proxy configuration.
Copy link
Contributor

Choose a reason for hiding this comment

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

Does this mean

The GUI will redirect from `<path>` to `<lang>/<path>` automatically using the
user browser language, if that is defined for the installation. Else using the default 
language defined in the reverse proxy configuration.

Copy link
Member Author

Choose a reason for hiding this comment

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

I guess it does.

Copy link
Contributor

Choose a reason for hiding this comment

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

Could you spell that out to make it easier to read?

Copy link
Member Author

Choose a reason for hiding this comment

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

I changed the wording.

@hannaeko hannaeko merged commit cf1c6ba into zonemaster:develop Aug 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Documentation Area: Documentation only. V-Patch Versioning: The change gives an update of patch in version.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update needed for API.md
2 participants