Skip to content

Linking to specific documentation on main dashboard pages#825

Open
CCuskley wants to merge 7 commits intomainfrom
linking-to-docs
Open

Linking to specific documentation on main dashboard pages#825
CCuskley wants to merge 7 commits intomainfrom
linking-to-docs

Conversation

@CCuskley
Copy link

Proposed changes

  • Creates a new DocsButton component that is reusable across pages (uses contrast blues from LEVANTE palette)
  • Add users:
    • Makes warning that groups have to be added first more prominent (previously light yellow and easy to miss)
    • changes text/instructions on add users page to line up with documentation
    • adds button linking to documentation.
  • Link users:
    • Makes warning that groups/uses must be added fiirst more prominent
    • Adds button linking to documentation
  • Groups page:
    • Adds brief text explaining groups
    • Adds button linking to groups documentation
  • View assignments
    • Adds button linking to getting started documentatiion (since this is where it first puts users on login)
  • Create assignments
    • Adds button linking to assignment docs and prompt to read documentation.
  • Top menu (global - UserActions.vue): Changes Researcher Documentation to Docs and adds book icon

Types of changes

What types of changes does this pull request introduce?

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Refactor (non-breaking change that does not add functionality but makes code cleaner or more efficient)
  • Tests (new or updated tests)
  • Styles (changes to code styling)
  • CI (continuous integration changes)
  • Other (please describe below)

Additional Notes

@CCuskley CCuskley linked an issue Mar 12, 2026 that may be closed by this pull request
2 tasks
@CCuskley CCuskley added the preview-assessment deploy preview as backend label Mar 12, 2026
@CCuskley CCuskley removed the preview-assessment deploy preview as backend label Mar 12, 2026
@github-actions
Copy link

github-actions bot commented Mar 12, 2026

Visit the preview URL for this PR (updated for commit 1b32125):

https://hs-levante-admin-dev--pr825-linking-to-docs-3yg43sdx.web.app

(expires Mon, 23 Mar 2026 18:59:56 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: 7889bff1da3bcc333d7422b9fc863c65b3962be7

fhconte
fhconte previously approved these changes Mar 18, 2026
Copy link
Member

@fhconte fhconte left a comment

Choose a reason for hiding this comment

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

Just sent some really small grammar and html default pattern correction as a common security practice. Non-blocking for this PR.

The site to which users are added is now determined by the site selected in the site selector (top right).
The Add Users process will only add users to the currently selected site, and will display a warning if your file contains a site column with values that do not match the currently selected site.
Users in those rows will cause the add users process to fail. We recommend splitting up your user files by site.
Previously, <code>site</code> was a requiired column in the user information file. Now it is no longer required, because all users will be added to the site chosen within the site selector on the top right of the dashbaord. If <code>site</code> exists in your spreadsheet and its values do not match the selected site, you will see a warning. We recommend having a separate user information file for each site.
Copy link
Member

Choose a reason for hiding this comment

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

Just a grammar correction for 'required' and 'dashboard'

<p>Notes:</p>
<ul>
<li>Reminder: Users either belong to a School and Class OR a Cohort.</li>
<li>Complete the appropriate column(s) according to the users' Group membership (School and Class OR Cohort).</li>
Copy link
Member

Choose a reason for hiding this comment

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

Found a duplicate space in 'according to'


<div class="how-to-section mb-4">
<h3>How to create groups</h3>
<div class="text-md text-gray-500 mb-1 line-height-3">Users are added to groups in order to receive tasks and surveys through assignments. Which kinds of groups you need will depend on your study design. Before getting started, please read <a href="https://researcher.levante-network.org/dashboard/create-a-group" target="_blank">the documentation on creating groups.</a></div>
Copy link
Member

Choose a reason for hiding this comment

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

Follow-up: Consider adding rel="noopener noreferrer" to the external target="_blank" links for consistency and common security practice. Non-blocking for this PR.

</div>
<div class="file-requirements-section">
<h2>User Information File Requirements</h2>
<p>Formatting requirements for your user information file are detailed in the table below. For more information, refer to the <a href="https://researcher.levante-network.org/dashboard/add-users" target="_blank">add users documentation</a>.</p>
Copy link
Member

Choose a reason for hiding this comment

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

Same follow-up: Consider adding rel="noopener noreferrer" to the external target="_blank".

@fhconte fhconte self-requested a review March 18, 2026 15:53
Copy link
Member

@fhconte fhconte left a comment

Choose a reason for hiding this comment

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

I will wait for the grammar corrections and functionalitty tests to confirm its approval

@fhconte fhconte dismissed their stale review March 18, 2026 15:54

I will wait for the grammar corrections and functionalitty tests to confirm its approval

@fhconte fhconte self-requested a review March 18, 2026 15:55
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.

[Feature] Add links to researcher documentation on each page

2 participants