catwell / staffeng42.github.io

Staff42 web site

Welcome to the official repository for the Staff42 community website. This site is built with Hugo, a fast and modern static site generator, and is designed to serve as a platform for French staff-plus engineers to share knowledge, insights, and experiences through blogging articles.

The public Web site is available at https://staffeng42.github.io/

How to contribute to the site?

git clone [e-mail]:staffeng42/staffeng42.github.io.git

cd staffeng42.github.io

Pre-requisites

Install either npm or yarn

Install dependencies

Install with NPM

npm install

-or- install with Yarn

yarn

Start local server

Develop with NPM

npm run start

-or- develop with Yarn

yarn start

Build static website for production

Build with NPM

npm run build

-or- Build with Yarn

yarn build

You should now be able to see the site running locally on http://localhost:1313/.

Contributing

We welcome contributions from all members of the Staff42 community. Here's how you can contribute:

Reporting Issues

If you find any bugs or have a feature request, please use the Issues section of this repository to let us know.

Submitting Articles

To submit an article:

1. Fork the repository.
2. Create a new branch for your article.
3. Add your article as a new markdown file in the content/posts directory.
4. Commit your changes with a clear message describing the article.
5. Push your changes to your fork.
6. Submit a pull request to the main repository.
7. Please ensure your article follows the content guidelines:
   • Write in French, as it is the primary language of the Staff42 community.
   • Keep your content relevant to staff-plus engineers.
   • Provide valuable insights or information.
   • Maintain a professional tone.

Review Process

All submissions will go through a review process by the Staff42 editorial team. We aim to provide feedback or merge your contributions quickly.

Deployment

The Staff42 website is automatically deployed when changes are merged into the main branch. Our CI/CD pipeline handles the build and deployment processes.

Support

If you need help or have questions about using Hugo or contributing to the website, please reach out to the community maintainers or open a discussion in the Discussions section of this repository.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Thank you for being a part of the Staff42 community and for your interest in contributing to our website. Together, we can make this a valuable resource for all staff-plus engineers.