Skip to content

Tutorial code #565

Merged
ronaldtse merged 30 commits into
mainfrom
tutorial
Mar 5, 2024
Merged

Tutorial code #565
ronaldtse merged 30 commits into
mainfrom
tutorial

Conversation

@kickoke

@kickoke kickoke commented Jan 31, 2022

Copy link
Copy Markdown
Contributor

This branch contains the tutorial content that we initially wanted to publish during the Google season of Docs project.
We've decided to make some alterations, for example, to include OGC examples instead of ISO examples.
The exercise descriptons for the lessons are stored in the file exercises.adoc. The file contains a liquid "case" structure to iterate through the different exercises.

The code for the exercises lives in the metanorma tutorial repository.
Since we don't have a playground directly on the website, I've told the users to download the repository and follow along in the files.

Before we merge, there are still some "Bugs" that I would like to address. I hope that @strogonoff might know how we can fix them.

  • Review the Terms and definitions sections. Can you (@ronaldtse) check if the information is still fine or if we should introduce the Concepts and Designations, too? Does the absolute beginner need to know these?
  • Tutorial needs to show up as a tab in the main navigation. I tried that in a local build but it broke the code. @strogonoff you might know how to amend this.
  • The following lessons are a top-level navigation item: lesson-1, lesson-2, lesson-3, lesson-4. Because I used the base-docs.html template, they contain the automatically generated "further in this section" portion. I don't think this section is useful in the context of tutorials, so we need to touch the open-theme repository for this. However, because this is the theme repository for other sites too, we could probably create a new formatting template for the tutorials.
  • @strogonoff If possible, I would like to change the appearance of some additional elements.
    image
  1. The task checkboxes should not have leading bullet points
  2. The "Hint" dropdown is currently black, but to increase the awareness for them, I'd like them to be in one of our brand colors.
  3. The button in each lesson is currently displayed as a link, although I have changed the respective Sass file. @strogonoff maybe you can have a look at this?

I hope we can solve these issues quickly so that users can finally benefit from the tutorial :)

Comment thread _sass/metanorma-rules.scss Outdated
.cta .button .tutorial{
@include cta-button($primary-dark-color, white);
border-radius: 25px;
&:hover {background-color: #9c60c1ff}

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Declaration should be terminated by a semicolon
Selector should have depth of applicability no greater than 2, but was 3

Comment thread _sass/metanorma-rules.scss Outdated
Comment thread _sass/metanorma-rules.scss
@ronaldtse

Copy link
Copy Markdown
Contributor

@kwkwan can you please help check these files and fix any problematic content? Also need to fix links. Thanks!

@ronaldtse ronaldtse assigned kwkwan and unassigned strogonoff and kickoke Mar 3, 2024
@ronaldtse
ronaldtse merged commit df16f3f into main Mar 5, 2024
@ronaldtse

Copy link
Copy Markdown
Contributor

Merging this and cleaning up later!

@ronaldtse
ronaldtse deleted the tutorial branch March 5, 2024 08:19
@kwkwan kwkwan mentioned this pull request Mar 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs enhancement New feature or request

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

4 participants