Byte Maze

How to can contribute

This is the official repository of Byte Maze, a website created with the idea of sharing content about technologies, whether about programming languages, software, technologies, cultures, tips, or any other topic related to the world of technology.

We are a group of people who like collaborative work, so if you feel like contributing any content related to technology, choosing a topic, and developing your idea, you are always welcome here.

Byte Maze is a static website built with Jekyll. All content is generated using Markdown. To learn more about this lightweight markup language, you can use this link.

⚠️   All content on this website must be written in English. Texts written in another language will not be accepted.

If you dare to collaborate with this project, you must follow these steps:

1. To start, you have to create a new branch from the main branch, with the following name: doc/document-name
2. Add you personal information in the data/authors.yml file.
3. Create a new markdown file inside the _posts/ folder with the following name: <publication-date>-<short-name>.md, and write your article. Learn how to work with this Jekyll Template.
4. After writing your article, go to the Actions tab and run the Build-and-Deploy workflow on your branch to check the Build of the website with your changes. The deployment will show you an error, this is normal because it is not possible to deploy the Website to another branch other than the Main one.
5. After the Build stage finishes successfully, you must submit the article through a Pull Request to be reviewed and published.
6. All commits made must be described with a clear message and follow the Conventional Commits message structure.

Complete Workflow

gitGraph
   commit
   commit

   branch doc/document-name-A
   commit id: "A--1"
   commit id: "A--2"

   checkout main
   branch doc/document-name-B
   commit id: "B--1"
   commit id: "B--2"
   commit id: "B--3"

   checkout main
   merge doc/document-name-A
   merge doc/document-name-B
   
   commit

Loading

Working locally

The idea of running the website locally is to test your changes without affecting the online website. If you choose to run locally, you need to clone this repository and follow the same flow described above.

To test your changes locally, you must have these packages installed.

• Ruby version 2.7.0 or higher, including all development headers (check your Ruby version using ruby -v)
• RubyGems (check your Gems version using gem -v)
• GCC and Make (check versions using gcc -v, g++ -v, and make -v)

If you don't have these packages installed or the versions are not as recommended, please update your packages or install them following these instructions:

Ubuntu

sudo apt-get install ruby-full build-essential zlib1g-dev

Avoid installing RubyGems packages (called gems) as the root user. Instead, set up a gem installation directory for your user account. The following commands will add environment variables to your ~/.bashrc file to configure the gem installation path:

echo '# Install Ruby Gems to ~/gems' >> ~/.bashrc
echo 'export GEM_HOME="$HOME/gems"' >> ~/.bashrc
echo 'export PATH="$HOME/gems/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc

Finally, install Jekyll and Bundler:

gem install jekyll bundler

MacOs

Please follow these instructions: Link Here

Windows

Please follow these instructions: Link Here

Running locally

Finally, you must run this command at the root of the project.

bundle exec jekyll serve