Add contribution segment (#463)

ml6team · Sep 26, 2023 · df83004 · df83004
1 parent 2fa8ea8
commit df83004
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@
     <a href="https://fondant.readthedocs.io/en/stable/"><strong>Explore the docs »</strong></a>
     <br>
     <br>
-    <a href="https://discord.gg/HnTdWhydGp"><img alt="Hello" src="https://dcbadge.vercel.app/api/server/HnTdWhydGp?style=flat-square"></a>
+    <a href="https://discord.gg/HnTdWhydGp"><img alt="Discord" src="https://dcbadge.vercel.app/api/server/HnTdWhydGp?style=flat-square"></a>
     <a href="https://pypi.org/project/fondant/"><img alt="PyPI version" src="https://img.shields.io/pypi/v/fondant?color=brightgreen&style=flat-square"></a>
     <a href="https://fondant.readthedocs.io/en/latest/license/"><img alt="License" src="https://img.shields.io/github/license/ml6team/fondant?style=flat-square&color=brightgreen"></a>
     <a href="https://github.com/ml6team/fondant/actions/workflows/pipeline.yaml"><img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/ml6team/fondant/pipeline.yaml?style=flat-square"></a>
@@ -327,15 +327,8 @@ board](https://github.com/orgs/ml6team/projects/1).
 
 ## 👭 Contributing
 
-We welcome contributions of different kinds:
+We welcome [contributions of different kinds](https://fondant.readthedocs.io/en/latest/contributing)
 
-|                                  |                                                                                                                                                                                                                                                                                                                           |
-|----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **Issues**                       | If you encounter any issue or bug, please submit them as a [Github issue](https://github.com/ml6team/fondant/issues). You can also submit a pull request directly to fix any clear bugs.                                                                                                                                  |
-| **Suggestions and feedback**     | If you have any suggestions or feedback, please reach out via our [Discord server](https://discord.gg/HnTdWhydGp) or [Github Discussions](https://github.com/ml6team/fondant/discussions)!                                                                                                                                |
-| **Framework code contributions** | If you want to help with the development of the Fondant framework, have a look at the issues marked with the [good first issue](https://github.com/ml6team/fondant/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) label. If you want to add additional functionality, please submit an issue for it first. |
-| **Reusable components**          | Extending our library of reusable components is a great way to contribute. If you built a component which would be useful for other users, please submit a PR adding them to the [components/](https://github.com/ml6team/fondant/tree/main/components) directory. You can find a list of possible components [here](https://github.com/ml6team/fondant/issues?q=is%3Aissue+is%3Aopen+label%3A%22Component+Contribution%22) or your own ideas are also welcome!                                            |
-| **Example pipelines**            | If you built a pipeline with Fondant which can serve as an example to other users, please submit a PR adding them to the [examples/](https://github.com/ml6team/fondant/tree/main/examples) directory.                                                                                                                    |
 
 ### Environment setup
 

diff --git a/docs/contributing.md b/docs/contributing.md
@@ -0,0 +1,15 @@
+# 👭 Contributing
+
+We welcome contributions of different kinds:
+
+|                                  |                                                                                                                                                                                                                                                                                                                           |
+|----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **Issues**                       | If you encounter any issue or bug, please submit them as a [Github issue](https://github.com/ml6team/fondant/issues). You can also submit a pull request directly to fix any clear bugs.                                                                                                                                  |
+| **Suggestions and feedback**     | If you have any suggestions or feedback, please reach out via our [Discord server](https://discord.gg/HnTdWhydGp) or [Github Discussions](https://github.com/ml6team/fondant/discussions)!                                                                                                                                |
+| **Framework code contributions** | If you want to help with the development of the Fondant framework, have a look at the issues marked with the [good first issue](https://github.com/ml6team/fondant/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) label. If you want to add additional functionality, please submit an issue for it first. |
+| **Reusable components**          | Extending our library of reusable components is a great way to contribute. If you built a component which would be useful for other users, please submit a PR adding them to the [components/](https://github.com/ml6team/fondant/tree/main/components) directory. You can find a list of possible contributable components [here](https://github.com/ml6team/fondant/issues?q=is%3Aissue+is%3Aopen+label%3A%22Component+Contribution%22) or your own ideas are also welcome!                                            |
+| **Example pipelines**            | If you built a pipeline with Fondant which can serve as an example to other users, please submit a PR adding them to the [examples/](https://github.com/ml6team/fondant/tree/main/examples) directory.   
+| **Fondant-cc-25m**               | Fondant-cc-25m contains 25 million image URLs with their respective Creative Commons license information collected from the Common Crawl web corpus. This [dataset](https://huggingface.co/datasets/fondant-ai/fondant-cc-25m) was created with Fondant and is under active development. Any help on making this dataset better or making cool use cases with this dataset is welcome!
+
+
+If you have any questions or ideas feel free to reach out to us on [Discord](https://discord.gg/HnTdWhydGp)!
diff --git a/docs/getting_started.md b/docs/getting_started.md
@@ -17,11 +17,11 @@ Clone the Fondant GitHub repository
 ```
 git clone https://github.com/ml6team/fondant.git
 ```
-Make sure that Docker Compose is running, navigate to fondant/examples/pipelines/filter-cc-25m, and initiate the pipeline by executing:
+Make sure that Docker Compose is running, navigate to `fondant/examples/pipelines/filter-cc-25m`, and initiate the pipeline by executing:
 ```
 fondant run pipeline --local
 ```
-Note: For local testing purposes, the pipeline will only download the first 100,000 images. If you want to download the full dataset, you will need to modify the component arguments in the pipeline.py file, specifically the following part:
+Note: For local testing purposes, the pipeline will only download the first 10,000 images. If you want to download the full dataset, you will need to modify the component arguments in the pipeline.py file, specifically the following part:
 ```python
 load_from_hf_hub = ComponentOp(
     component_dir="components/load_from_hf_hub",

diff --git a/docs/guides/build_a_simple_pipeline.md b/docs/guides/build_a_simple_pipeline.md
@@ -167,7 +167,7 @@ Finally, we add the component to the pipeline using the `add_op` method. Notably
 
 Now, you can proceed to execute your pipeline once more and explore the results. In the explorer, you will be able to view the images that have been downloaded.
 
-![explorer](/art/guides/explorer.png)
+![explorer](https://github.com/ml6team/fondant/blob/main/docs/art/guides/explorer.png?raw=true)
 
 
 

diff --git a/docs/guides/implement_custom_components.md b/docs/guides/implement_custom_components.md
@@ -22,7 +22,7 @@ This pipeline is an extension of the one introduced in the first tutorial. After
 
 A component comprises several key elements. First, there's the ComponentSpec YAML file, serving as a blueprint for the component. It defines crucial aspects such as input and output dataframes, along with component arguments.
 
-![component architecture](/art/guides/component.png)
+![component architecture](https://github.com/ml6team/fondant/blob/main/docs/art/guides/component.png?raw=true)
 
 The second essential part is a python class, which encapsulates the business logic that operates on the input dataframe.
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -29,6 +29,7 @@ theme:
 nav:
   - Home: index.md
   - Getting Started: getting_started.md
+  - Contributing: contributing.md
   - Guides:
     - Build a simple pipeline: guides/build_a_simple_pipeline.md
     - Implement custom components: guides/implement_custom_components.md