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

CSSTUDIO-2180: add help page #144

Merged
merged 2 commits into from
Apr 16, 2024
Merged

CSSTUDIO-2180: add help page #144

merged 2 commits into from
Apr 16, 2024

Conversation

cjenkscybercom
Copy link
Contributor

@cjenkscybercom cjenkscybercom commented Apr 10, 2024

Summary of Changes

  • Adds help page (accessible to all users)
  • Adds new env variables (REACT_APP_SUPPORT_HREF, REACT_APP_VERSION, REACT_APP_VERSION_HREF), documented in README

Default help shows documentation link leading to the docs here:
Screenshot 2024-04-10 at 14 25 54

Customized help displays links to custom docs, support URL, and version URL (e.g. source code or release notes)

Screenshot 2024-04-10 at 16 06 49

Visual Inspection

  • Conformance to Markdown styles: https://olog.esss.lu.se/Olog/help/CommonmarkCheatsheet
    • ...when viewing a log entry
    • ...when previewing HTML while writing a description
    • ...when viewing a log entry in the group view
  • Scroll is possible (elements don't overflow their container, and they are scrollable)
    • ...search result list
    • ...log entry group view list
    • ...log entry single view
    • ...create new log entry page
  • Overall layout fills full width and height of viewport
  • Pagination element doesn't overflow into other elements

@cjenkscybercom
Copy link
Contributor Author

Please disregard flaky tests; they pass locally.

@cjenkscybercom cjenkscybercom merged commit bb036d0 into main Apr 16, 2024
5 of 6 checks passed
@cjenkscybercom cjenkscybercom deleted the CSSTUDIO-2180-help-page branch April 16, 2024 14:36
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.

2 participants