Onboarding

Onboarding for Marfeel developers.

The trainings are organised in modules, following Marfeel's core concepts. Modules usually mix guided trainings with Marfeelers, reading, and autonomous hands-on practice.

If you are missing information in order to complete a module, encounter broken links or can't get a hands-on practice to work, open an issue on MarfeelDocs (opens new window)! This onboarding is a live project.

Module 1: Getting started (process, product, people)

Goal: getting familiar with Marfeel organization, and have an operational local environment.

Take one or two days for this module, making sure you follow all the environment-related steps, including the check. Let the ada team know when you're done with it! And raise your hand for any setup issue, in order to fix it early.

1. Marfeel: getting started

   • Start with the overview and read the Marfeel product's walk-through.
   • Setup your local environment whenever you are ready.
   • If your environment is set-up, check that everything works!

2. Marfeel corporate tools & processes (opens new window)

   • Learn about which software are used accross Marfeel and how to install them (including non-tech: Zoom, Lastpass...)

3. Marfeel Teams (opens new window) (link to Atenea platform)

   • Presentation of Marfeel teams

Module 2: Demos

Goal: learn how to build a demo, getting familiar with the file structure of a tenant.

1. Recommended reads:

As this is the first module, a lot of reading is needed. Select articles at your own pace!

• Covering the basics:
  • Marfeel as an infinitely extensible platform
  • Marfeel tenant's architecture
  • Working with a tenant in local

Going further

• The definition.json file overview
• The whiteCollar script
• The ui.json file overview

TIP

The articles in the first group are important to understand Marfeel product and start contributing. The second group contains more in-depth articles, read them when you need them.

2. Build a first demo step-by-step:

3. Build demos yourself! See the list of suggested demos at the end of the presentation.

Module 3: Theming and Styling

Goal: learn how to customize a tenant's Marfeel site following a prototype.

1. Recommended reads:

• The basics:
  • Styling at Marfeel overview
  • Global components in a Marfeel site
  • The ui.json file overview

Going further

• Using SASS at Marfeel
• Layout descriptor

2. Style a tenant step-by-step.

Check the slides directly for links (opens new window).

Module 4: Menu Configuration and Section extractions

Goal: learn how to place content inside Marfeel site, following the tenant's desktop version.

1. Recommended reads:

• Covering the basics:
  • Definition.json file overview
  • Content Platform's building blocks
  • Rippers

Going further

• The whiteCollar script
• Deploy a site
• Content groups
• Puppeteer at Marfeel

2. Build a menu for a tenant step-by-step:

Check the slides directly for links (opens new window).

3. Fill up section pages for a tenant step-by-step:

Check the slides directly for links (opens new window).

Module 5: Article pages extraction

Goal: learn how to select content for article pages inside a Marfeel website, following the tenant's desktop version.

1. Recommended reads:

• Covering the basics:
  • Marfeel Boilerpipe
  • Content Platform's building blocks

Going further

• Blacklist and Whitelist
• Article page components

2. Learn how to extract content on article pages step-by-step:

Check the slides directly for links (opens new window).

Module 6: Final tenant

Goal: Put in practice everything you have learned this week, by marfeelizing a tenant from scratch.

Use this Figma prototype (opens new window) created by the Design team to marfeelize tuttoandroid.mrf.io (opens new window).