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

Learning paths docs #1007

Merged
merged 11 commits into from
Aug 2, 2024
Merged

Learning paths docs #1007

merged 11 commits into from
Aug 2, 2024

Conversation

PhilReedData
Copy link
Contributor

Summary of changes

  • Added new page for learning paths documentation, and added to a few other pages.

Motivation and context

  • As discussed at TeSS Club.

Screenshots

image

Checklist

  • I have read and followed the CONTRIBUTING guide.
  • I confirm that I have the authority necessary to make this contribution on behalf of its copyright owner and agree
    to license it to the TeSS codebase under the
    BSD license.

Copy link
Member

@fbacall fbacall left a comment

Choose a reason for hiding this comment

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

Looks good, just a few small changes

@@ -3,7 +3,7 @@
</div>
<div class="row">
<div class="col-md-4 col-md-push-8">
<%# render :partial => "learning_paths/partials/general_learning_path_info" %>
<% render :partial => "learning_paths/partials/general_learning_path_info" %>
Copy link
Member

Choose a reason for hiding this comment

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

This needs to start with <%=

For example, learning paths from the ELIXIR community will follow the protocol created by the
ELIXIR Training Platform/Learning Paths Focus Group.</li></ul>
<p>Governance: Maintaining the learning path</p>
<ol><li>It is the responsibility of the learning path curator to maintain their community&raquo;s learning paths.</li>
Copy link
Member

Choose a reason for hiding this comment

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

&raquo; should just be replaced with ' I think, or it can end up looking like this:
image

learning path to add them to a list. You can view your starred resources later by clicking the user icon
at the top-right of the screen then 'My stars'. To use the star feature you need to be a registered TeSS user.</li>
view_topics: >
<ol><li>On the 'Learning paths' tab, click the 'Topics' button at the top-right.</li>
Copy link
Member

Choose a reason for hiding this comment

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

Forgot to mention in the original doc, but this button is actually labelled "Manage Topics" in the latest version of TeSS (not deployed yet)

[email protected] to request permission.</p>
<p>The three steps to register a learning path are described in full detail below.</p>
training_material: >
<p>To <a href='about/registering'>register training materials follow the instructions here</a>.
Copy link
Member

Choose a reason for hiding this comment

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

For the link here its better to let Rails generate the correct path. You can do it like we did here:

<p><%== t('about.subscription_manager', subscriptions_path: subscriptions_path) %></p>

in this case it would be registering_resources_path

@@ -3,7 +3,7 @@
</div>
<div class="row">
<div class="col-md-4 col-md-push-8">
<%# render :partial => "learning_paths/partials/general_learning_path_info" %>
<% render :partial => "learning_path_topics/partials/general_learning_path_topic_info" %>
Copy link
Member

Choose a reason for hiding this comment

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

Needs to start with <%= to appear on the page

@fbacall fbacall merged commit 17b33fa into ElixirTeSS:master Aug 2, 2024
7 checks passed
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