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 node experiences to Technical and Operational page of website. Fixes #21. #77

Merged
merged 42 commits into from
Jan 15, 2024

Conversation

malloryfreeberg
Copy link
Contributor

@malloryfreeberg malloryfreeberg commented Dec 14, 2023

Description

Node experiences written by representatives of FEGA Finland, Norway, Poland and Sweden were added to the "Technical and Operational" page of the FEGA Onboarding website in the "Learn from current node implementations" section. In this first addition of content, five different experiences are described by 1-3 nodes. Each experience is listed followed by a list of clickable name(s) of a node which expands to show that node's content. Each block of content follows the same template of listing the Author(s) and including 4 subheadings: What did we do?, What went well?, What could have gone better?, and What did we learn?.

Motivation and Context

Fixes #21. It has been recognised by current and onboarding FEGA nodes that learning from previous nodes' experiences setting up their FEGA node is highly valuable. By sharing node experiences in a structured, static way on the onboarding website, interested nodes can learn from this and hopefully have a more efficient journey joining the FEGA network.

How has this been tested?

The actual node experience content was simply copied and pasted from a working Google document that all nodes contributed to. To test the expandable content aspect of the website, the site was locally built and served using the method described below.

What should reviewers focus on?

  1. Review the text for your node's experiences. Ensure it aligns with what you want to share. Suggest changes if you want to add or change anything. Note that I made a few edits for consistency (e.g. changed all the "Central EGA") but otherwise kept all the content the same.
  2. Test the expandable content. This feature functions differently in the GitHub markdown versus the Jekyll-rendered website. To test the expandable content experience in the website, you can do the following to test it locally:
    1. In a terminal, git clone the FEGA-onboarding repository and navigate to it using cd FEGA-onboarding. NB If you've cloned the repo previously, simply use git pull to get the latest changes.
    2. Switch to the mf-add-node-experiences branch locally on your computer using git checkout mf-add-node-experiences.
    3. Locally build and serve the website by running bundle exec jekyll serve. NB You might need to install/update dependencies to use this feature. See more info here.
    4. Open the local server address (e.g. http://127.0.0.1:4000/FEGA-onboarding/) in a browser, click "docs/", then navigate to the "Node experiences" section e.g. using the left-hand navigation panel.
    5. Click on the node names to expand/collapse content.
  3. Provide feedback on how the sections looks. The markdown is a bit hacky, but I tried to get the content to look as nice as possible. If you have suggestions on how to make it look nicer, I will see what I can do (or maybe ask someone to help!)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New content (non-breaking change which adds new content)
  • Modified content (non-breaking change which modifies existing content)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

  • I have read the CONTRIBUTING.md guide.
  • My changes follow the code style of this project.
  • I have updated supporting documentation, if required.
  • I have added my details to the CONTRIBUTORS.yaml file.

@malloryfreeberg malloryfreeberg added the documentation Improvements or additions to documentation label Dec 14, 2023
@malloryfreeberg malloryfreeberg requested review from M-casado and amycurwin and removed request for ahornos January 11, 2024 07:57
Copy link
Collaborator

@M-casado M-casado left a comment

Choose a reason for hiding this comment

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

Reviewed the style and links, but not the content of the nodes' experiences.
I added a few custom changes to the file custom.css to modify the style of the expandable content, so that it looks more like the following

image

@amycurwin
Copy link
Collaborator

I really like the changes. I managed to see the changes locally myself and I think this format looks great! Thanks Marcos!

Copy link
Collaborator

@amycurwin amycurwin left a comment

Choose a reason for hiding this comment

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

Looks great!

@malloryfreeberg malloryfreeberg merged commit aa8e866 into main Jan 15, 2024
@malloryfreeberg malloryfreeberg deleted the mf-add-node-experiences branch January 15, 2024 10:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add nodes' lessons learned in a structured way
3 participants