diff --git a/.github/workflows/devportal-update.yml b/.github/workflows/devportal-update.yml index dca21bee..86f4dd81 100644 --- a/.github/workflows/devportal-update.yml +++ b/.github/workflows/devportal-update.yml @@ -26,6 +26,7 @@ jobs: echo "BRANCH_NAME=${BRANCH_NAME}" >> $GITHUB_ENV git clone https://github.com/rsksmart/devportal.git + cat devportal/docs/02-developers/06-integrate/01-rif-relay/integrate.md cd devportal git checkout -b ${BRANCH_NAME} || git checkout ${BRANCH_NAME} cd .. @@ -39,7 +40,7 @@ jobs: TEMP_FILE="temp_README.md" tail -n +1 README.md > ${TEMP_FILE} # Remove the lines between - awk '//{next} {print}' README.md > ${TEMP_FILE} + # awk '//{next} {print}' README.md > ${TEMP_FILE} # Process main README.md TRANSFORMED_FILE="transformed/README.md" @@ -84,167 +85,23 @@ jobs: cp transformed/integrate.md devportal/docs/02-developers/06-integrate/01-rif-relay/integrate.md cat devportal/docs/02-developers/06-integrate/01-rif-relay/integrate.md - # # Process setup section - # TEMP_FILE="temp_installation-requirements.md" - # TRANSFORMED_FILE="transformed/installation-requirements.md" - # # Remove the unwanted first lines from section (title) - # tail -n +1 docs/installation-requirements.md > ${TEMP_FILE} - # echo "---" > ${TRANSFORMED_FILE} - # echo "sidebar_label: Setup" >> ${TRANSFORMED_FILE} - # echo "sidebar_position: 300" >> ${TRANSFORMED_FILE} - # echo "title: RIF Relay Installation Requirements >> ${TRANSFORMED_FILE} - # echo "description: 'Requirements for installing RIF Relay.'" >> ${TRANSFORMED_FILE} - # echo "tags: [rif, envelope, relay, user, guide]" >> ${TRANSFORMED_FILE} - # echo "---" >> ${TRANSFORMED_FILE} - # echo "" >> ${TRANSFORMED_FILE} - # cat ${TEMP_FILE} >> ${TRANSFORMED_FILE} - # # Clean up temporary file - # rm ${TEMP_FILE} - # cp ${TRANSFORMED_FILE} devportal/docs/02-developers/06-integrate/01-rif-relay/installation-requirements.md - - # # Process sample dapp section - # TEMP_FILE="temp_sample-dapp.md" - # TRANSFORMED_FILE="transformed/sample-dapp.md" - # # Remove the unwanted first lines from section (title) - # tail -n +1 docs/sample-dapp.md > ${TEMP_FILE} - # echo "---" > ${TRANSFORMED_FILE} - # echo "sidebar_label: RIF Relay Sample dApp" >> ${TRANSFORMED_FILE} - # echo "sidebar_position: 400" >> ${TRANSFORMED_FILE} - # echo "title: How to use the RIF Relay Sample dApp SDK >> ${TRANSFORMED_FILE} - # echo "description: 'RIF Relay Sample dApp SDK Starter kit.'" >> ${TRANSFORMED_FILE} - # echo "tags: [rif, envelope, relay, integration guide]" >> ${TRANSFORMED_FILE} - # echo "---" >> ${TRANSFORMED_FILE} - # echo "" >> ${TRANSFORMED_FILE} - # cat ${TEMP_FILE} >> ${TRANSFORMED_FILE} - # # Clean up temporary file - # rm ${TEMP_FILE} - # cp ${TRANSFORMED_FILE} devportal/docs/02-developers/06-integrate/01-rif-relay/sample-dapp.md - - # # Process deployment section - # TEMP_FILE="temp_deployment.md" - # TRANSFORMED_FILE="transformed/deployment.md" - # # Remove the unwanted first lines from section (title) - # tail -n +1 docs/deployment.md > ${TEMP_FILE} - # echo "---" > ${TRANSFORMED_FILE} - # echo "sidebar_label: RIF Relay Deployment" >> ${TRANSFORMED_FILE} - # echo "sidebar_position: 500" >> ${TRANSFORMED_FILE} - # echo "title: RIF Relay Deployment >> ${TRANSFORMED_FILE} - # echo "description: 'RIF Relay deployment process.'" >> ${TRANSFORMED_FILE} - # echo "tags: [rif, envelope, relay, integration guide]" >> ${TRANSFORMED_FILE} - # echo "---" >> ${TRANSFORMED_FILE} - # echo "" >> ${TRANSFORMED_FILE} - # cat ${TEMP_FILE} >> ${TRANSFORMED_FILE} - # # Clean up temporary file - # rm ${TEMP_FILE} - # cp ${TRANSFORMED_FILE} devportal/docs/02-developers/06-integrate/01-rif-relay/deployment.md - - # # Process develop section - # TEMP_FILE="temp_develop.md" - # TRANSFORMED_FILE="transformed/develop.md" - # # Remove the unwanted first lines from section (title) - # tail -n +1 docs/develop.md > ${TEMP_FILE} - # echo "---" > ${TRANSFORMED_FILE} - # echo "sidebar_label: Develop" >> ${TRANSFORMED_FILE} - # echo "sidebar_position: 600" >> ${TRANSFORMED_FILE} - # echo "title: RIF Relay Develop >> ${TRANSFORMED_FILE} - # echo "description: 'RIF Relay deployment process.'" >> ${TRANSFORMED_FILE} - # echo "tags: [rif, envelope, relay, user, guide]" >> ${TRANSFORMED_FILE} - # echo "---" >> ${TRANSFORMED_FILE} - # echo "" >> ${TRANSFORMED_FILE} - # cat ${TEMP_FILE} >> ${TRANSFORMED_FILE} - # # Clean up temporary file - # rm ${TEMP_FILE} - # cp ${TRANSFORMED_FILE} devportal/docs/02-developers/06-integrate/01-rif-relay/develop.md - - # # Process contracts section - # TEMP_FILE="temp_contracts.md" - # TRANSFORMED_FILE="transformed/contracts.md" - # # Remove the unwanted first lines from section (title) - # tail -n +1 docs/contracts.md > ${TEMP_FILE} - # echo "---" > ${TRANSFORMED_FILE} - # echo "sidebar_label: Contracts" >> ${TRANSFORMED_FILE} - # echo "sidebar_position: 700" >> ${TRANSFORMED_FILE} - # echo "title: RIF Relay - Contracts >> ${TRANSFORMED_FILE} - # echo "description: 'RIF Relay Contracts.'" >> ${TRANSFORMED_FILE} - # echo "tags: [rif, envelope, relay, integrate]" >> ${TRANSFORMED_FILE} - # echo "---" >> ${TRANSFORMED_FILE} - # echo "" >> ${TRANSFORMED_FILE} - # cat ${TEMP_FILE} >> ${TRANSFORMED_FILE} - # # Clean up temporary file - # rm ${TEMP_FILE} - # cp ${TRANSFORMED_FILE} devportal/docs/02-developers/06-integrate/01-rif-relay/contracts.md - - # # Process smart wallets section - # TEMP_FILE="temp_smart-wallets.md" - # TRANSFORMED_FILE="transformed/smart-wallets.md" - # # Remove the unwanted first lines from section (title) - # tail -n +1 docs/smart-wallets.md > ${TEMP_FILE} - # echo "---" > ${TRANSFORMED_FILE} - # echo "sidebar_label: Smart Wallets" >> ${TRANSFORMED_FILE} - # echo "sidebar_position: 800" >> ${TRANSFORMED_FILE} - # echo "title: RIF Relay Smart Wallets >> ${TRANSFORMED_FILE} - # echo "description: 'RIF Relay Smart Wallets.'" >> ${TRANSFORMED_FILE} - # echo "tags: [rif, envelope, relay, user, guide]" >> ${TRANSFORMED_FILE} - # echo "---" >> ${TRANSFORMED_FILE} - # echo "" >> ${TRANSFORMED_FILE} - # cat ${TEMP_FILE} >> ${TRANSFORMED_FILE} - # # Clean up temporary file - # rm ${TEMP_FILE} - # cp ${TRANSFORMED_FILE} devportal/docs/02-developers/06-integrate/01-rif-relay/smart-wallets.md - - # # Process versions section - # TEMP_FILE="temp_versions.md" - # TRANSFORMED_FILE="transformed/versions.md" - # # Remove the unwanted first lines from section (title) - # tail -n +1 docs/versions.md > ${TEMP_FILE} - # echo "---" > ${TRANSFORMED_FILE} - # echo "sidebar_label: Versions" >> ${TRANSFORMED_FILE} - # echo "sidebar_position: 900" >> ${TRANSFORMED_FILE} - # echo "title: RIF Relay Versions >> ${TRANSFORMED_FILE} - # echo "description: 'RIF Relay Versions.'" >> ${TRANSFORMED_FILE} - # echo "tags: [rif, envelope, rif relay, integration guide]" >> ${TRANSFORMED_FILE} - # echo "---" >> ${TRANSFORMED_FILE} - # echo "" >> ${TRANSFORMED_FILE} - # cat ${TEMP_FILE} >> ${TRANSFORMED_FILE} - # # Clean up temporary file - # rm ${TEMP_FILE} - # cp ${TRANSFORMED_FILE} devportal/docs/02-developers/06-integrate/01-rif-relay/versions.md - - # # Process gas costs section - # TEMP_FILE="temp_gas-costs.md" - # TRANSFORMED_FILE="transformed/gas-costs.md" - # # Remove the unwanted first lines from section (title) - # tail -n +1 docs/gas-costs.md > ${TEMP_FILE} - # echo "---" > ${TRANSFORMED_FILE} - # echo "sidebar_label: Gas Costs" >> ${TRANSFORMED_FILE} - # echo "sidebar_position: 950" >> ${TRANSFORMED_FILE} - # echo "title: RIF Relay - Gas Costs >> ${TRANSFORMED_FILE} - # echo "description: 'RIF Relay Gas Costs.'" >> ${TRANSFORMED_FILE} - # echo "tags: [rif, envelope, relay, integrate]" >> ${TRANSFORMED_FILE} - # echo "---" >> ${TRANSFORMED_FILE} - # echo "" >> ${TRANSFORMED_FILE} - # cat ${TEMP_FILE} >> ${TRANSFORMED_FILE} - # # Clean up temporary file - # rm ${TEMP_FILE} - # cp ${TRANSFORMED_FILE} devportal/docs/02-developers/06-integrate/01-rif-relay/gas-costs.md - - # # Process architecture section - # TEMP_FILE="temp_architecture.md" - # TRANSFORMED_FILE="transformed/architecture.md" - # # Remove the unwanted first lines from section (title) - # tail -n +1 docs/architecture.md > ${TEMP_FILE} - # echo "---" > ${TRANSFORMED_FILE} - # echo "sidebar_label: Architecture" >> ${TRANSFORMED_FILE} - # echo "sidebar_position: 980" >> ${TRANSFORMED_FILE} - # echo "title: RIF Relay - Architecture >> ${TRANSFORMED_FILE} - # echo "description: 'RIF Relay Architeture.'" >> ${TRANSFORMED_FILE} - # echo "tags: [rif, envelope, relay, integrate]" >> ${TRANSFORMED_FILE} - # echo "---" >> ${TRANSFORMED_FILE} - # echo "" >> ${TRANSFORMED_FILE} - # cat ${TEMP_FILE} >> ${TRANSFORMED_FILE} - # # Clean up temporary file - # rm ${TEMP_FILE} - # cp ${TRANSFORMED_FILE} devportal/docs/02-developers/06-integrate/01-rif-relay/architecture.md + # Process setup section + TEMP_FILE="temp_installation-requirements.md" + TRANSFORMED_FILE="transformed/installation-requirements.md" + # Remove the unwanted first lines from section (title) + tail -n +1 docs/installation-requirements.md > temp_installation-requirements.md + echo "---" > transformed/installation-requirements.md + echo "sidebar_label: Setup" >> transformed/installation-requirements.md + echo "sidebar_position: 300" >> transformed/installation-requirements.md + echo "title: RIF Relay Installation Requirements >> transformed/installation-requirements.md + echo "description: 'Requirements for installing RIF Relay.'" >> transformed/installation-requirements.md + echo "tags: [rif, envelope, relay, user, guide]" >> transformed/installation-requirements.md + echo "---" >> transformed/installation-requirements.md + echo "" >> transformed/installation-requirements.md + cat temp_installation-requirements.md >> transformed/installation-requirements.md + # Clean up temporary file + rm temp_installation-requirements.md + cp transformed/installation-requirements.md devportal/docs/02-developers/06-integrate/01-rif-relay/installation-requirements.md # Step 3: Commit and Push Changes to Devportal Repository - name: Commit and Push Changes diff --git a/README.md b/README.md index 81f1169f..516e38e8 100644 --- a/README.md +++ b/README.md @@ -42,4 +42,4 @@ Each module has instructions for development and usage. * Please refer to the Rootstock Contribution Guidelines for more information on how to contribute to this project. ## License: -MIT License - Copyright (c) 2023 Rootstock \ No newline at end of file +MIT License - Copyright (c) 2023 Rootstock diff --git a/docs/installation-requirements.md b/docs/installation-requirements.md index 03499d3c..72116dbd 100644 --- a/docs/installation-requirements.md +++ b/docs/installation-requirements.md @@ -33,4 +33,6 @@ For a detailed step-by-step guide on getting started with RIF Relay, refer to th ### Using Docker -- RIF Relay components can be deployed using Docker or locally using [Hardhat](#hardhat). A guide for the [RIF Relay Server](https://github.com/rsksmart/rif-relay-server#execute-as-a-docker-container) can be found in the repository. \ No newline at end of file +- RIF Relay components can be deployed using Docker or locally using [Hardhat](#hardhat). A guide for the [RIF Relay Server](https://github.com/rsksmart/rif-relay-server#execute-as-a-docker-container) can be found in the repository. + +test \ No newline at end of file