Skip to content

Commit

Permalink
markdown linter
Browse files Browse the repository at this point in the history
  • Loading branch information
edo-aleix-penella authored and apenella committed Dec 27, 2023
1 parent 4f6d9fd commit c2b6160
Show file tree
Hide file tree
Showing 19 changed files with 331 additions and 129 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@ When a new site's release is ready to be deployed on your development environmen

1) Create a pull request to the `main` branch
2) Merge the pull request, and then the `Publish` action is triggered.
3) Once the `Publish` action is completed properly, the site is already available on https://gostevedore.github.io/
3) Once the `Publish` action is completed properly, the site will be available at https://gostevedore.github.io/

> The `Publish` action pushes the code generated by `Hugo` to `gh-pages` repository's branch.
12 changes: 9 additions & 3 deletions content/en/docs/_index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

---
title: "Documentation"
linkTitle: "Documentation"
Expand All @@ -17,6 +16,7 @@ One of the key benefits of using Stevedore is that it provides a consistent way
Overall, Stevedore is a useful tool for anyone who needs to build and manage large numbers of Docker images, and it can help to improve the experience of building and promoting Docker images at scale.

## Why stevedore?

Stevedore simplifies the building of Docker images in a standardized way, with the ability to define relationships between them.

You can build images from multiple sources, including local files and git repositories, and generate automatic tags for semantic versioning.
Expand All @@ -26,19 +26,25 @@ Stevedore also offers a credentials store for easy authentication to Docker regi
## Features

### Standardize

Build your Docker images in a standardized way. Create a Dockerfile and reuse it for as many use cases as needed

### Relatives build

Automate the building of related Docker images by defining their relationships and dependencies

### Credentials
Store credentials to log in to your Docker registry, AWS Elastic Container Registry or a Git server

Store credentials to log in to your Docker registry, AWS Elastic Container Registry, or Git server

### Promote

Easily promote or copy Docker images from one registry to another using Stevedore's image promotion feature

### Semver awareness

Automatically generate tags for semantic version 2.0.0 when building Docker image

### Multiple build contexts
Build your images using multiple build context sources. Use local files, a git repository or merge several sources

Build your images using multiple build context sources. Use local files, a git repository, or merge several sources
10 changes: 10 additions & 0 deletions content/en/docs/contribution-guidelines/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,11 @@ description: How to contribute to Stevedore
---

# Contributing to Stevedore

Thank you for your interest in contributing to Stevedore! All contributions are welcome, whether they are bug reports, feature requests, or code contributions.

## Getting Started

Before contributing to Stevedore, you should:

1. Fork the repository.
Expand All @@ -16,13 +18,17 @@ Before contributing to Stevedore, you should:
4. Create a new branch for your changes.

## How to Contribute

### Bug Reports

If you find a bug in Stevedore, please report it by creating a new issue on our GitHub repository. Please include as much information as possible, including a description of the bug, the steps to reproduce it, and any error messages you received.

### Feature Requests

If you have a feature request, please create a new issue on our GitHub repository. Please include a detailed description of the feature, as well as any relevant use cases or examples.

### Code Contributions

If you would like to contribute code to Stevedore, please follow these steps:

1. Create a new branch for your changes.
Expand All @@ -32,6 +38,7 @@ If you would like to contribute code to Stevedore, please follow these steps:
Please ensure that your code adheres to our coding standards, that all tests pass before submitting a pull request, and you update the project [README](https://github.com/gostevedore/stevedore/blob/main/README.md), the [documentation](https://github.com/gostevedore/gostevedore.github.io), and the [RELEASE_NOTES](https://github.com/gostevedore/stevedore/blob/main/RELEASE_NOTES.md).

## Coding Standards

When contributing code to Stevedore, please adhere to the following coding standards:

- Use clear, descriptive variable and function names.
Expand All @@ -40,10 +47,13 @@ When contributing code to Stevedore, please adhere to the following coding stand
- Write tests for your code.

## Issue Management

We use GitHub to manage issues and feature requests. To report a bug or request a feature, please create a new issue on our GitHub repository.

## Documentation

Documentation is an important part of the Stevedore project, and we rely on contributions from our community to keep it up-to-date. If your contribution involves changes to the behaviour of the Stevedore project, please make sure to update the documentation accordingly. This could include updating the [README](https://github.com/gostevedore/stevedore/blob/main/README.md) file, adding or modifying usage examples, or creating new [documentation](https://github.com/gostevedore/gostevedore.github.io) pages as needed. We encourage all contributors to participate in improving the documentation, as it helps ensure that the project is accessible and useful to as many people as possible.

## Thank You

Thank you for your interest in contributing to Stevedore! All contributions are appreciated.
10 changes: 8 additions & 2 deletions content/en/docs/contribution-guidelines/code-of-conduct.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,28 @@ description: Stevedore has a code of conduct that all contributors are expected

# Stevedore Project Code of Conduct

The Stevedore project is committed to providing a friendly, safe and welcoming environment for all, regardless of gender, sexual orientation, disability, ethnicity, religion, or similar personal characteristic.
The Stevedore project is committed to providing a friendly, safe, and welcoming environment for all, regardless of gender, sexual orientation, disability, ethnicity, religion, or similar personal characteristics.

We expect all contributors, users, and community members to follow this code of conduct. This includes all interactions within the Stevedore community, whether online, in person, or otherwise.

## Code of Conduct

### Be respectful and inclusive

We encourage participation from everyone. Please be respectful and considerate towards others, and avoid any language, images, or actions that could be considered disrespectful, offensive, or exclusionary.

### Listen and be open to constructive feedback

Be open to constructive feedback and criticism from others. We all have room to learn, grow, and improve, and being open to feedback is an important part of that process.

### Don't harass or discriminate

Harassment or discrimination of any kind will not be tolerated. This includes but is not limited to derogatory comments or slurs, sexual harassment, and unwanted physical contact or attention. If you experience or witness any form of harassment or discrimination, please report it immediately.

### Don't engage in disruptive behaviour

Disruptive behaviour, such as spamming, trolling, or other malicious behaviour, will not be tolerated. We want to maintain a positive and productive environment for everyone.

## Acknowledgements
## Acknowledgments

This Code of Conduct is adapted from the Contributor Covenant, version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
14 changes: 10 additions & 4 deletions content/en/docs/docs-v0.11/_index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

---
title: "Documentation v0.11"
linkTitle: "Documentation v0.11"
Expand All @@ -10,11 +9,12 @@ description: >

Stevedore is a tool for building Docker images at scale, and it is not intended to replace Dockerfile or Buildkit. Instead, Stevedore can be used in conjunction with these tools to help streamline the process of building and promoting multiple Docker images.

One of the key benefits of using Stevedore is that it provides a consistent and modular way to build Docker images, which can be helpful when dealing with large and complex projects that require multiple images. By using a set of "workers" to perform specific tasks during the build process, you can create a more efficient and automated process for building and promoting Docker images.
One of the key benefits of using Stevedore is that it provides a consistent way to build Docker images and its descendant images, which can be helpful when dealing with large and complex projects that require multiple images. You can also create a more efficient and automated process for building and promoting Docker images.

Overall, Stevedore is a useful tool for anyone who needs to build and manage large numbers of Docker images, and it can help to improve the experience of building and promoting Docker images at scale.

## Why stevedore?

Stevedore simplifies the building of Docker images in a standardized way, with the ability to define relationships between them.

You can build images from multiple sources, including local files and git repositories, and generate automatic tags for semantic versioning.
Expand All @@ -24,19 +24,25 @@ Stevedore also offers a credentials store for easy authentication to Docker regi
## Features

### Standardize

Build your Docker images in a standardized way. Create a Dockerfile and reuse it for as many use cases as needed

### Relatives build

Automate the building of related Docker images by defining their relationships and dependencies

### Credentials
Store credentials to log in to your Docker registry, AWS Elastic Container Registry or a Git server

Store credentials to log in to your Docker registry, AWS Elastic Container Registry, or Git server

### Promote

Easily promote or copy Docker images from one registry to another using Stevedore's image promotion feature

### Semver awareness

Automatically generate tags for semantic version 2.0.0 when building Docker image

### Multiple build contexts
Build your images using multiple build context sources. Use local files, a git repository or merge several sources

Build your images using multiple build context sources. Use local files, a git repository, or merge several sources
10 changes: 10 additions & 0 deletions content/en/docs/docs-v0.11/contribution-guidelines/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,11 @@ description: How to contribute to Stevedore
---

# Contributing to Stevedore

Thank you for your interest in contributing to Stevedore! All contributions are welcome, whether they are bug reports, feature requests, or code contributions.

## Getting Started

Before contributing to Stevedore, you should:

1. Fork the repository.
Expand All @@ -16,13 +18,17 @@ Before contributing to Stevedore, you should:
4. Create a new branch for your changes.

## How to Contribute

### Bug Reports

If you find a bug in Stevedore, please report it by creating a new issue on our GitHub repository. Please include as much information as possible, including a description of the bug, the steps to reproduce it, and any error messages you received.

### Feature Requests

If you have a feature request, please create a new issue on our GitHub repository. Please include a detailed description of the feature, as well as any relevant use cases or examples.

### Code Contributions

If you would like to contribute code to Stevedore, please follow these steps:

1. Create a new branch for your changes.
Expand All @@ -32,6 +38,7 @@ If you would like to contribute code to Stevedore, please follow these steps:
Please ensure that your code adheres to our coding standards, that all tests pass before submitting a pull request, and you update the project [README](https://github.com/gostevedore/stevedore/blob/main/README.md), the [documentation](https://github.com/gostevedore/gostevedore.github.io), and the [RELEASE_NOTES](https://github.com/gostevedore/stevedore/blob/main/RELEASE_NOTES.md).

## Coding Standards

When contributing code to Stevedore, please adhere to the following coding standards:

- Use clear, descriptive variable and function names.
Expand All @@ -40,10 +47,13 @@ When contributing code to Stevedore, please adhere to the following coding stand
- Write tests for your code.

## Issue Management

We use GitHub to manage issues and feature requests. To report a bug or request a feature, please create a new issue on our GitHub repository.

## Documentation

Documentation is an important part of the Stevedore project, and we rely on contributions from our community to keep it up-to-date. If your contribution involves changes to the behaviour of the Stevedore project, please make sure to update the documentation accordingly. This could include updating the [README](https://github.com/gostevedore/stevedore/blob/main/README.md) file, adding or modifying usage examples, or creating new [documentation](https://github.com/gostevedore/gostevedore.github.io) pages as needed. We encourage all contributors to participate in improving the documentation, as it helps ensure that the project is accessible and useful to as many people as possible.

## Thank You

Thank you for your interest in contributing to Stevedore! All contributions are appreciated.
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,28 @@ description: Stevedore has a code of conduct that all contributors are expected

# Stevedore Project Code of Conduct

The Stevedore project is committed to providing a friendly, safe and welcoming environment for all, regardless of gender, sexual orientation, disability, ethnicity, religion, or similar personal characteristic.
The Stevedore project is committed to providing a friendly, safe, and welcoming environment for all, regardless of gender, sexual orientation, disability, ethnicity, religion, or similar personal characteristics.

We expect all contributors, users, and community members to follow this code of conduct. This includes all interactions within the Stevedore community, whether online, in person, or otherwise.

## Code of Conduct

### Be respectful and inclusive

We encourage participation from everyone. Please be respectful and considerate towards others, and avoid any language, images, or actions that could be considered disrespectful, offensive, or exclusionary.

### Listen and be open to constructive feedback

Be open to constructive feedback and criticism from others. We all have room to learn, grow, and improve, and being open to feedback is an important part of that process.

### Don't harass or discriminate

Harassment or discrimination of any kind will not be tolerated. This includes but is not limited to derogatory comments or slurs, sexual harassment, and unwanted physical contact or attention. If you experience or witness any form of harassment or discrimination, please report it immediately.

### Don't engage in disruptive behaviour

Disruptive behaviour, such as spamming, trolling, or other malicious behaviour, will not be tolerated. We want to maintain a positive and productive environment for everyone.

## Acknowledgements
## Acknowledgments

This Code of Conduct is adapted from the Contributor Covenant, version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
Loading

0 comments on commit c2b6160

Please sign in to comment.