Skip to content

Commit

Permalink
updating documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
tosin2013 committed Mar 18, 2024
1 parent cf90a6d commit 98d772e
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions docs/index.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,35 @@ To contribute code changes, please follow these steps:
4. Push your changes to your forked repository.
5. Open a pull request to the main repository, describing your changes in detail.

### Contributing to the Notebooks Repository

In addition to the main workshop repository, we also have a separate repository for Jupyter notebooks related to edge anomaly detection: [edge-anomaly-detection-notebooks](https://github.com/tosin2013/edge-anomaly-detection-notebooks).

To contribute to the notebooks repository, follow these steps:

1. Fork the [edge-anomaly-detection-notebooks](https://github.com/tosin2013/edge-anomaly-detection-notebooks) repository on GitHub.
2. Create a new branch for your changes.
3. Add new notebooks or update existing ones with your contributions.
4. Commit your changes with descriptive commit messages.
5. Push your changes to your forked repository.
6. Open a pull request to the main notebooks repository, describing your changes in detail.

We appreciate contributions that add new examples, tutorials, or experiments related to edge anomaly detection using Jupyter notebooks. Please make sure your notebooks are well-documented and follow best practices for reproducibility.


### Contributing to the Applications Repository

We also have a separate repository for developing sample applications related to edge anomaly detection using us OPC UA client and server based on `python-opcua`: [opcua-asyncio-build-pipelines](https://github.com/tosin2013/opcua-asyncio-build-pipelines/tree/main).

To contribute to the notebooks repository, follow these steps:

1. Fork the [opcua-asyncio-build-pipelines](https://github.com/tosin2013/opcua-asyncio-build-pipelines/tree/main) repository on GitHub.
2. Create a new branch for your changes.
3. Add new notebooks or update existing ones with your contributions.
4. Commit your changes with descriptive commit messages.
5. Push your changes to your forked repository.
6. Open a pull request to the main notebooks repository, describing your changes in detail.


## Additional Resources

Expand Down

0 comments on commit 98d772e

Please sign in to comment.