Skip to content

rte-france/rte-france.github.io

Repository files navigation

Open Source at RTE: A Dedicated Website

This GitHub Pages website provides a comprehensive overview of RTE’s involvement in Open Source. It explains the reasons behind RTE’s commitment to Open Source and highlights the various projects where RTE is actively contributing. Additionally, it serves as a central hub for accessing the GitHub repositories of our main contributions.

You can visit our website at https://opensource.rte-france.com

Adding an entry to your project

  1. Ask for Write access to this repo (you can open a new issue or contact a team member), in order to be able to open a Pull Request
  2. Create a page under "_projects_lfe", "_projects_rte", or "_projects_contribution" (depending on the type of your project) with the name of your project, by copying the template here
  3. Fill out the template; you can find inspiration in existing project pages
  4. Add your logo / images to the "assets/images" directory if needed (create a subdirectory for your project)
  5. To preview the result on your PC, you must first install ruby bundler & development kits, for example on ubuntu:
    apt install ruby-bundler
    apt install ruby-dev
    Then run the following lines:
    bundle install
    bundle exec jekyll serve
  6. Open a pull request
  7. We will review your pull request and merge it when everything is OK!

Contributing to improving the website

You are welcome to suggest improvements to the overall UX / UI of the website.
First of all, you need to as for Write access (see above). Then you can open pull requests.
The website uses Jekyll with the minimal-mistakes theme.
Most of the features are configured in the _config?yml file.
Some custom HTML & CSS has been necessary in order to make the website look the way it does. The source code of these customizations is in the _includes, _layouts, and _sass directories. These are meant to override or augment the theme's default resources.

🪟 Installation on Windows

Install Ruby

  1. Go to the official RubyInstaller website https://rubyinstaller.org and download and install rubyinstaller-devkit-3.1.4-1-x64.exe
    ⚠️ Important:
    • Do not install a more recent version than 3.1.4
    • During installation, select both Ruby base and MSYS2 Devkit
  2. Add Ruby to the Windows PATH to your Windows environment variables: X:...\Ruby31-x64\bin (Adapt the path depending on where Ruby is installed.)
  3. To verify that Ruby is correctly installed, open PowerShell and run:
ruby -v

If successful, the Ruby version should be displayed.

Install Bundler and Jekyll

gem install bundler -v 2.3.26
gem install jekyll

##Install Project Dependencies Navigate to the repository folder containing the Gemfile, install and run the local server :

bundle _2.3.26_ install
bundle _2.3.26_ exec jekyll serve

Open the Website

Once the server is running, open your browser and go to: http://127.0.0.1:4000 Your site should now be running locally

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors