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

Add a configurable about page #341

Merged
merged 4 commits into from Jan 25, 2023
Merged

Add a configurable about page #341

merged 4 commits into from Jan 25, 2023

Conversation

msm-code
Copy link
Contributor

@msm-code msm-code commented Jan 22, 2023

Your checklist for this pull request

  • I've read the contributing guideline.
  • I've tested my changes by building and running mquery, and testing changed functionality (if applicable)
  • I've added automated tests for my change (if applicable, optional)
  • I've updated documentation to reflect my change (if applicable)

What is the current behaviour?

There is no way to add any customised information for the users #323

What is the new behaviour?
This PR adds (will add) a customisable "about" page. It's not very customisable, because all the information will have to fit into a config file, but that should be enough to give users a few URLs or explain what's going on.

image

This subpage is optional (will be optional in the final PR).

I've decided to allow HTML (it's trusted - it comes from the server) instead of just plain text.

Test plan

Visit /about.

Closing issues

fixes #323

@msm-code msm-code requested a review from nazywam January 22, 2023 02:27
@msm-code msm-code marked this pull request as draft January 22, 2023 11:39
@msm-code msm-code changed the title Add a (soon) configurable about page Add a configurable about page Jan 24, 2023
@msm-code
Copy link
Contributor Author

msm-code commented Jan 24, 2023

Rebased onto typed config. Ready for review.

@msm-code msm-code marked this pull request as ready for review January 24, 2023 21:58
>
<span className="navbar-toggler-icon" />
</button>
<div className="container-fluid">
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is a bit unrelated to the current PR - new bootstrap requires navbar contents to be contained within a conteiner-fluid div

@@ -130,3 +130,4 @@ class ServerSchema(BaseModel):
auth_enabled: Optional[str]
openid_url: Optional[str]
openid_client_id: Optional[str]
about: str
Copy link
Member

Choose a reason for hiding this comment

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

This will be populated with the default value "" if not present in the database, right?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes. Originally this was Optional[str] in the schema too, but I realised this will never actually be null.

@msm-code msm-code merged commit 846f69a into master Jan 25, 2023
@msm-code msm-code deleted the feature/about-page branch January 25, 2023 17:40
@msm-code msm-code mentioned this pull request Feb 9, 2023
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.

Create a configurable "about" page
2 participants