Skip to content

Commit

Permalink
chore(cleanup): deleted deprecated files and folders
Browse files Browse the repository at this point in the history
Deleted 'docs-cactus' and 'weaver/docs' folders.
Ensured that the latest contents in the above are reflected in the 'docs' folder.
Updated MAINTAINERS.md file with contents from 'weaver/MAINTAINERS.md'.
Deleted unnecessary 'MAINTAINERS.md' and 'CONTRIBUTING.md' in the 'weaver' folder.
Fixed indentations and removed dead code in source files.
Modified GitHub action to test docs build upon change

Signed-off-by: VRamakrishna <vramakr2@in.ibm.com>
  • Loading branch information
VRamakrishna committed Jul 10, 2024
1 parent d6629c5 commit 6baaf66
Show file tree
Hide file tree
Showing 197 changed files with 101 additions and 8,261 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/deploy_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ on:

paths:
- 'docs/**'

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

Expand All @@ -31,7 +31,7 @@ jobs:

# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- uses: actions/checkout@v4.1.1

- name: Use Python 3.x
uses: actions/setup-python@v4
with:
Expand Down
23 changes: 11 additions & 12 deletions .github/workflows/test_weaver-node-pkgs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ jobs:
docs_changed:
- '.github/workflows/test_weaver-node-pkgs.yaml'
- 'weaver/docs/**'
- 'docs/**'
unit_test_weaver_node_sdk_local:
needs: check_code_changed
Expand Down Expand Up @@ -132,23 +132,22 @@ jobs:
run: npm run test
working-directory: weaver/core/identity-management/iin-agent

build_docs:
needs: check_code_changed
if: needs.check_code_changed.outputs.docs_changed == 'true'
build-docs:
runs-on: ubuntu-22.04
steps:
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- uses: actions/checkout@v4.1.1

- name: Use Node.js ${{ env.NODEJS_LTS_VERSION }}
uses: actions/setup-node@v4.0.2
- name: Use Python 3.x
uses: actions/setup-python@v4
with:
node-version: ${{ env.NODEJS_LTS_VERSION }}
python-version: '3.10'
cache: 'pip' # caching pip dependencies

- name: NPM INSTALL
run: npm install
working-directory: weaver/docs
- name: Install dependencies
run: pip install -r requirements.txt
working-directory: docs

- name: Build
run: npm run build
working-directory: weaver/docs
run: mkdocs build
working-directory: docs
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,10 @@ As a developer:
* if you only have a little time, consider picking up a [“help-wanted”](https://github.com/hyperledger/cacti/labels/help%20wanted) or ["good-first-issue"](https://github.com/hyperledger/cacti/labels/good%20first%20issue) task
* If you can commit to full-time development, then please contact us on our [Discord channel](https://discord.com/channels/905194001349627914/908379338716631050) to work through logistics!

We welcome contributions to this project in many forms, whether it is to fix a bug, improve the documentation, add a new feature, or add support for any new DLT platform.

Please familiarize yourself with the [documentation](https://hyperledger.github.io/cacti/). In particular, review the [vision and design methodology](https://hyperledger.github.io/cacti/vision/) and [system architecture](https://hyperledger.github.io/cacti/architecture/). Follow the tutorial instructions to test the [Cactus](https://hyperledger.github.io/cacti/cactus/introduction/) and [Weaver](https://hyperledger.github.io/cacti/weaver/introduction/) features respectively. (For a deeper understanding of the Weaver design and specifications, also check out the [Weaver RFCs](https://github.com/hyperledger/cacti/tree/main/weaver/rfcs).)

## Git Know How / Reading List

This section is for you if you do not know your way around advanced git concepts such as
Expand Down
25 changes: 25 additions & 0 deletions MAINTAINERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,31 @@ Maintainers
| Name | GitHub | Chat |
|------|--------|------|
| Jonathan Hamilton | [jonathan-m-hamilton][jonathan-m-hamilton] | JHamilton |
| Krishnasuri Narayanam | [knarayan][knarayan] | Krishnasuri |
| Dhinakaran Vinayagamurthy | [dhinakaran2705][dhinakaran2705] | Dhinakaran |

[jonathan-m-hamilton]: https://github.com/jonathan-m-hamilton
[knarayan]: https://github.com/knarayan
[dhinakaran2705]: https://github.com/dhinakaran2705

Below is a list of former contributors to the [Weaver Lab](https://github.com/hyperledger-labs/weaver-dlt-interoperability) project, which is now a part of Cacti.

| Name | GitHub | Chat |
|------|--------|------|
| Ermyas Abebe | [ermyas][ermyas] | - |
| Nick Waywood | [nwaywood][nwaywood] | - |
| Dileban Karunamoorthy | [dileban][dileban] | - |
| Allison Irvin | [airvin][airvin] | - |
| Antony Targett | [AntTargett][AntTargett] | - |
| Yining Hu | [Yining-Hu][Yining-Hu] | - |
| Vinayaka Pandit | [Vinayaka-Pandit][Vinayaka-Pandit] | - |
| Christian Vecchiola | [Christian-Vecchiola][Christian-Vecchiola] | - |

[ermyas]: https://github.com/ermyas
[nwaywood]: https://github.com/nwaywood
[dileban]: https://github.com/dileban
[airvin]: https://github.com/airvin
[AntTargett]: https://github.com/AntTargett
[Yining-Hu]: https://github.com//Yining-Hu
[Vinayaka-Pandit]: https://github.com/Vinayaka-Pandit
[Christian-Vecchiola]: https://github.com/hyp0th3rmi4
20 changes: 0 additions & 20 deletions docs-cactus/Makefile

This file was deleted.

9 changes: 0 additions & 9 deletions docs-cactus/README.md

This file was deleted.

84 changes: 0 additions & 84 deletions docs-cactus/architecture/class-diagram.puml

This file was deleted.

83 changes: 0 additions & 83 deletions docs-cactus/architecture/deployment-diagram.puml

This file was deleted.

This file was deleted.

Loading

0 comments on commit 6baaf66

Please sign in to comment.