From fbd697dc1b7090920665c3bafa141976d9aeb98b Mon Sep 17 00:00:00 2001 From: mahula Date: Thu, 9 Nov 2023 10:53:26 +0100 Subject: [PATCH 1/7] fix links in .md files --- CONTRIBUTING.md | 4 ++-- README.md | 4 ++-- deployment/Minikube.md | 4 ++-- deployment/README.md | 16 ++++++++-------- deployment/deployment.md | 4 ++-- deployment/src/old/digital-ocean/README.md | 2 +- 6 files changed, 17 insertions(+), 17 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 650785331..2f8d06a8b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ Thank you so much for thinking of contributing to the [ocelot.social](https://oc ## Getting Set Up -Instructions for how to install all the necessary software and some code guidelines can be found in our main [Readme](/README.md) or in our [documentation](/SUMMARY.md). +Instructions for how to install all the necessary software and some code guidelines can be found in our main [Readme](./README.md) or in our [documentation](./SUMMARY.md). To get you started we recommend that you join forces with a regular contributor. Please join [our Discord instance](https://discord.gg/AJSX9DCSUA) to chat with developers or just get in touch directly on an issue on either [Github](https://github.com/Ocelot-Social-Community/Ocelot-Social/issues) or [Zenhub](https://app.zenhub.com/workspaces/ocelotsocial-5fb21ff922cb410015dd6535/board?filterLogic=any&repos=301151089): @@ -36,7 +36,7 @@ Every pull request needs to: ## Contribution Flow For Open Source Contributors -See [contributing in main README.md](/README.md#contributing) +See [contributing in main README.md](./README.md#contributing) ## The Team diff --git a/README.md b/README.md index ab9ba0ef9..0ab7cf80c 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![Build Status Test](https://github.com/Ocelot-Social-Community/Ocelot-Social/actions/workflows/test.yml/badge.svg)](https://github.com/Ocelot-Social-Community/Ocelot-Social/actions) [![Build Status Publish](https://github.com/Ocelot-Social-Community/Ocelot-Social/actions/workflows/publish.yml/badge.svg)](https://github.com/Ocelot-Social-Community/Ocelot-Social/actions) -[![MIT License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/Ocelot-Social-Community/Ocelot-Social/blob/LICENSE.md) +[![MIT License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/Ocelot-Social-Community/Ocelot-Social/blob/master/LICENSE.md) [![Discord Channel](https://img.shields.io/discord/489522408076738561.svg)](https://discord.gg/AJSX9DCSUA) [![Open Source Helpers](https://www.codetriage.com/ocelot-social-community/ocelot-social/badges/users.svg)](https://www.codetriage.com/ocelot-social-community/ocelot-social) @@ -73,7 +73,7 @@ If you're wondering how you could help, there are plenty of ways, e.g.: - Promote it on your social networks. - Tell your friends about it by word-of-mouth. - Write a press article on ocelot.social or contact the editorial office of your local news page or radio station. -- Take a [good first issue](https://github.com/Ocelot-Social-Community/Ocelot-Social/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) or issues that need help. Make sure to read [CONTRIBUTING.md](/CONTRIBUTING.md) first though. +- Take a [good first issue](https://github.com/Ocelot-Social-Community/Ocelot-Social/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) or issues that need help. Make sure to read [CONTRIBUTING.md](./CONTRIBUTING.md) first though. - Testing and [reporting](https://github.com/Ocelot-Social-Community/Ocelot-Social/issues/new/choose) bugs. - Translating: Please [contact us](#contact). - Reviewing and testing pull requests. diff --git a/deployment/Minikube.md b/deployment/Minikube.md index 8e6240a7c..851afa46c 100644 --- a/deployment/Minikube.md +++ b/deployment/Minikube.md @@ -11,7 +11,7 @@ $ minikube dashboard This will give you an overview. Some of the steps below need some timing to make resources available to other dependent deployments. Keeping an eye on the dashboard is a great way to check that. -Follow the installation instruction for [Kubernetes with Helm](./kubernetes/README.md). +Follow the installation instruction for [Kubernetes with Helm](./deployment/src/kubernetes/README.md). If all the pods and services have settled and everything looks green in your minikube dashboard, expose the services you want on your host system. @@ -22,4 +22,4 @@ For example: $ minikube service webapp --namespace=ocelotsocialnetwork # optionally $ minikube service backend --namespace=ocelotsocialnetwork -``` \ No newline at end of file +``` diff --git a/deployment/README.md b/deployment/README.md index 93d3fb86c..377346a0a 100644 --- a/deployment/README.md +++ b/deployment/README.md @@ -1,7 +1,7 @@ # Ocelot.Social Deploy And Rebranding [![Build Status Publish](https://github.com/Ocelot-Social-Community/Ocelot-Social-Deploy-Rebranding/actions/workflows/publish.yml/badge.svg)](https://github.com/Ocelot-Social-Community/Ocelot-Social-Deploy-Rebranding/actions) -[![MIT License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/Ocelot-Social-Community/Ocelot-Social-Deploy-Rebranding/blob/LICENSE.md) +[![MIT License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/Ocelot-Social-Community/Ocelot-Social-Deploy-Rebranding/blob/master/LICENSE.md) [![Discord Channel](https://img.shields.io/discord/489522408076738561.svg)](https://discord.gg/AJSX9DCSUA) [![Open Source Helpers](https://www.codetriage.com/ocelot-social-community/ocelot-social-deploy-rebranding/badges/users.svg)](https://www.codetriage.com/ocelot-social-community/ocelot-social-deploy-rebranding) @@ -39,7 +39,7 @@ Fork this repository to configure and rebrand it for your own [ocelot.social](ht Write your own data into the main configuration file: -- [package.json](/package.json) +- [package.json](./package.json) Since all deployment methods described here depend on [Docker](https://docker.com) and [DockerHub](https://hub.docker.com), you need to create your own organisation on DockerHub and put its name in the [package.json](/package.json) file as your `dockerOrganisation`. @@ -48,7 +48,7 @@ Since all deployment methods described here depend on [Docker](https://docker.co The next step is: - [Set Environment Variables and Configurations](./deployment-values.md) -- [Configure And Branding](./configurations/stage.ocelot.social/branding/README.md) +- [Configure And Branding](./deployment/configurations/stage.ocelot.social/branding/README.md) ### Optional: Locally Testing Configuration And Branding @@ -71,7 +71,7 @@ For the maintenance page have a look in your browser at `http://localhost:5000/` ### Push Changes To GitHub -Before merging these changes into the "master" branch on your GitHub fork repository, you need to configure the GitHub repository secrets. This is necessary to [publish](/.github/workflows/publish.yml) the Docker images by pushing them via GitHub actions to repositories belonging to your DockerHub organisation. +Before merging these changes into the "master" branch on your GitHub fork repository, you need to configure the GitHub repository secrets. This is necessary to [publish](./.github/workflows/publish.yml) the Docker images by pushing them via GitHub actions to repositories belonging to your DockerHub organisation. First, go to your DockerHub profile under `Account Settings` and click on the `Security` tab. There you create an access token called `-access-token` and copy the token to a safe place. @@ -100,9 +100,9 @@ See the login details and browser addresses above. ### Deployment -Afterwards you can [deploy](/deployment/deployment.md) it on your server: +Afterwards you can [deploy](./deployment/deployment.md) it on your server: -- [Kubernetes with Helm](/deployment/kubernetes/README.md) +- [Kubernetes with Helm](./deployment/src/kubernetes/README.md) ## Developer Chat @@ -131,7 +131,7 @@ Browser compatibility testing with [BrowserStack](https://www.browserstack.com/) ## License -See the [LICENSE](/LICENSE.md) file for license rights and limitations (MIT). +See the [LICENSE](./LICENSE.md) file for license rights and limitations (MIT). -We need `DOCKER_BUILDKIT=0` for this to work. \ No newline at end of file +We need `DOCKER_BUILDKIT=0` for this to work. diff --git a/deployment/deployment.md b/deployment/deployment.md index f085b48d0..c00bebe54 100644 --- a/deployment/deployment.md +++ b/deployment/deployment.md @@ -4,8 +4,8 @@ Before you start the deployment you have to do preparations. ## Deployment Preparations -Since all deployment methods described here depend on [Docker](https://docker.com) and [DockerHub](https://hub.docker.com), you need to create your own organisation on DockerHub and put its name in the [package.json](/package.json) file as your `dockerOrganisation`. -Read more details in the [main README](/README.md) under [Usage](/README.md#usage). +Since all deployment methods described here depend on [Docker](https://docker.com) and [DockerHub](https://hub.docker.com), you need to create your own organisation on DockerHub and put its name in the [package.json](./package.json) file as your `dockerOrganisation`. +Read more details in the [main README](./README.md) under [Usage](./README.md#usage). ## Deployment Methods diff --git a/deployment/src/old/digital-ocean/README.md b/deployment/src/old/digital-ocean/README.md index c5893f645..ab02754ac 100644 --- a/deployment/src/old/digital-ocean/README.md +++ b/deployment/src/old/digital-ocean/README.md @@ -30,7 +30,7 @@ do this as a last step. We are storing our images in the s3-compatible [DigitalOcean Spaces](https://www.digitalocean.com/docs/spaces/). -We still want to take backups of our images in case something happens to the images in the cloud. See these [instructions](https://www.digitalocean.com/docs/spaces/resources/s3cmd-usage/) about getting set up with `s3cmd` to take a copy of all images in a `Spaces` namespace, i.e. `ocelot-social-uploads`. +We still want to take backups of our images in case something happens to the images in the cloud. See these [instructions](https://docs.digitalocean.com/products/spaces/reference/s3cmd/) about getting set up with `s3cmd` to take a copy of all images in a `Spaces` namespace, i.e. `ocelot-social-uploads`. After configuring `s3cmd` with your credentials, etc. you should be able to make a backup with this command. From 419c5414aaec92815fa6d50ddc7117e156ad9c11 Mon Sep 17 00:00:00 2001 From: mahula Date: Thu, 9 Nov 2023 12:54:14 +0100 Subject: [PATCH 2/7] fix link in minimube documentation --- deployment/Minikube.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/deployment/Minikube.md b/deployment/Minikube.md index 851afa46c..a552e670f 100644 --- a/deployment/Minikube.md +++ b/deployment/Minikube.md @@ -11,7 +11,7 @@ $ minikube dashboard This will give you an overview. Some of the steps below need some timing to make resources available to other dependent deployments. Keeping an eye on the dashboard is a great way to check that. -Follow the installation instruction for [Kubernetes with Helm](./deployment/src/kubernetes/README.md). +Follow the installation instruction for [Kubernetes with Helm](./src/kubernetes/README.md). If all the pods and services have settled and everything looks green in your minikube dashboard, expose the services you want on your host system. From 6a96406b929effb88ff70d5462ebe654a798ac98 Mon Sep 17 00:00:00 2001 From: mahula Date: Thu, 9 Nov 2023 13:40:49 +0100 Subject: [PATCH 3/7] fix further links in documentation --- deployment/README.md | 10 +++++----- deployment/deployment.md | 4 ++-- deployment/src/kubernetes/DigitalOcean.md | 6 +++--- deployment/src/kubernetes/README.md | 6 +++--- .../src/old/volumes/neo4j-offline-backup/README.md | 2 +- 5 files changed, 14 insertions(+), 14 deletions(-) diff --git a/deployment/README.md b/deployment/README.md index 377346a0a..745ab8592 100644 --- a/deployment/README.md +++ b/deployment/README.md @@ -39,7 +39,7 @@ Fork this repository to configure and rebrand it for your own [ocelot.social](ht Write your own data into the main configuration file: -- [package.json](./package.json) +- [package.json](https://github.com/Ocelot-Social-Community/Ocelot-Social/blob/master/package.json) Since all deployment methods described here depend on [Docker](https://docker.com) and [DockerHub](https://hub.docker.com), you need to create your own organisation on DockerHub and put its name in the [package.json](/package.json) file as your `dockerOrganisation`. @@ -71,7 +71,7 @@ For the maintenance page have a look in your browser at `http://localhost:5000/` ### Push Changes To GitHub -Before merging these changes into the "master" branch on your GitHub fork repository, you need to configure the GitHub repository secrets. This is necessary to [publish](./.github/workflows/publish.yml) the Docker images by pushing them via GitHub actions to repositories belonging to your DockerHub organisation. +Before merging these changes into the "master" branch on your GitHub fork repository, you need to configure the GitHub repository secrets. This is necessary to [publish](../.github/workflows/publish.yml) the Docker images by pushing them via GitHub actions to repositories belonging to your DockerHub organisation. First, go to your DockerHub profile under `Account Settings` and click on the `Security` tab. There you create an access token called `-access-token` and copy the token to a safe place. @@ -100,9 +100,9 @@ See the login details and browser addresses above. ### Deployment -Afterwards you can [deploy](./deployment/deployment.md) it on your server: +Afterwards you can [deploy](./deployment.md) it on your server: -- [Kubernetes with Helm](./deployment/src/kubernetes/README.md) +- [Kubernetes with Helm](./src/kubernetes/README.md) ## Developer Chat @@ -131,7 +131,7 @@ Browser compatibility testing with [BrowserStack](https://www.browserstack.com/) ## License -See the [LICENSE](./LICENSE.md) file for license rights and limitations (MIT). +See the [LICENSE](../LICENSE.md) file for license rights and limitations (MIT). We need `DOCKER_BUILDKIT=0` for this to work. diff --git a/deployment/deployment.md b/deployment/deployment.md index c00bebe54..a8a571f33 100644 --- a/deployment/deployment.md +++ b/deployment/deployment.md @@ -4,14 +4,14 @@ Before you start the deployment you have to do preparations. ## Deployment Preparations -Since all deployment methods described here depend on [Docker](https://docker.com) and [DockerHub](https://hub.docker.com), you need to create your own organisation on DockerHub and put its name in the [package.json](./package.json) file as your `dockerOrganisation`. +Since all deployment methods described here depend on [Docker](https://docker.com) and [DockerHub](https://hub.docker.com), you need to create your own organisation on DockerHub and put its name in the [package.json](https://github.com/Ocelot-Social-Community/Ocelot-Social/blob/master/package.json) file as your `dockerOrganisation`. Read more details in the [main README](./README.md) under [Usage](./README.md#usage). ## Deployment Methods You have the following options for a deployment: -- [Kubernetes with Helm](./kubernetes/README.md) +- [Kubernetes with Helm](./src/kubernetes/README.md) ## After Deployment diff --git a/deployment/src/kubernetes/DigitalOcean.md b/deployment/src/kubernetes/DigitalOcean.md index 71c49d783..6bf854a6d 100644 --- a/deployment/src/kubernetes/DigitalOcean.md +++ b/deployment/src/kubernetes/DigitalOcean.md @@ -68,17 +68,17 @@ Take one of the IPs of perhaps two or more droplets in your cluster from the lis To understand what makes sense to do when managing your DNS with DigitalOcean, you need to know how DNS works: DNS means `Domain Name System`. It resolves domains like `example.com` into an IP like `123.123.123.123`. -DigitalOcean is not a domain registrar, but provides a DNS management service. If you use DigitalOcean's DNS management service, you can configure [your cluster](/deployment/kubernetes/README.md#dns) to always resolve the domain to the correct IP and automatically update it for that. +DigitalOcean is not a domain registrar, but provides a DNS management service. If you use DigitalOcean's DNS management service, you can configure [your cluster](./README.md#dns) to always resolve the domain to the correct IP and automatically update it for that. The IPs of the DigitalOcean machines are not necessarily stable, so the cluster's DNS service will update the DNS records managed by DigitalOcean to the new IP as needed. ***CAUTION:** If you are using an external DNS, you currently have to do this manually, which can cause downtime.* ## Deploy -Yeah, you're done here. Back to [Deployment with Helm for Kubernetes](/deployment/src/kubernetes/README.md). +Yeah, you're done here. Back to [Deployment with Helm for Kubernetes](./README.md). ## Backups On DigitalOcean -You can and should do [backups](/deployment/kubernetes/Backup.md) with Kubernetes for sure. +You can and should do [backups](./Backup.md) with Kubernetes for sure. Additional to backup and copying the Neo4j database dump and the backend images you can do a volume snapshot on DigitalOcean at the moment you have the database in sleep mode. diff --git a/deployment/src/kubernetes/README.md b/deployment/src/kubernetes/README.md index 17773d736..d78e1ad26 100644 --- a/deployment/src/kubernetes/README.md +++ b/deployment/src/kubernetes/README.md @@ -9,7 +9,7 @@ Please contact us if you are interested in options not listed below. Managed Kubernetes: -- [DigitalOcean](/deployment/src/kubernetes/DigitalOcean.md) +- [DigitalOcean](./DigitalOcean.md) ## Configuration @@ -165,7 +165,7 @@ $ doctl compute firewall get --context ***ATTENTION:** This seems not to work at all so we leave it away at the moment* -***TODO:** I thought this is necessary if we use the DigitalOcean DNS management service? See [Manage DNS With DigitalOcean](/deployment/kubernetes/DigitalOcean.md#manage-dns-with-digitalocean)* +***TODO:** I thought this is necessary if we use the DigitalOcean DNS management service? See [Manage DNS With DigitalOcean](./DigitalOcean.md#manage-dns-with-digitalocean)* This chart is only necessary (recommended is more precise) if you run DigitalOcean without load balancer. You need to generate an access token with read + write for the `dns.values.yaml` at and fill it in. @@ -280,7 +280,7 @@ helm uninstall ocelot \ ## Backups -You can and should do [backups](/deployment/kubernetes/Backup.md) with Kubernetes for sure. +You can and should do [backups](./Backup.md) with Kubernetes for sure. ## Error Reporting diff --git a/deployment/src/old/volumes/neo4j-offline-backup/README.md b/deployment/src/old/volumes/neo4j-offline-backup/README.md index 7c34aa764..76dd844a2 100644 --- a/deployment/src/old/volumes/neo4j-offline-backup/README.md +++ b/deployment/src/old/volumes/neo4j-offline-backup/README.md @@ -23,7 +23,7 @@ So, all we have to do is edit the kubernetes deployment of our Neo4J database and set a custom `command` every time we have to carry out tasks like backup, restore, seed etc. -First bring the application into [maintenance mode](https://github.com/Ocelot-Social-Community/Ocelot-Social/blob/master/deployment/ocelot-social/maintenance/README.md) to ensure there are no +First bring the application into [maintenance mode](https://github.com/Ocelot-Social-Community/Ocelot-Social/blob/master/webapp/maintenance/README.md#maintenance-mode) to ensure there are no database connections left and nobody can access the application. Run the following: From 52c8d5cf9c4420520e7a6252ffeb72f562b5533b Mon Sep 17 00:00:00 2001 From: mahula Date: Thu, 9 Nov 2023 13:52:08 +0100 Subject: [PATCH 4/7] activate verbose mode in doc check workflow --- .github/workflows/check-documentation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/check-documentation.yml b/.github/workflows/check-documentation.yml index d374f41e8..4ba745161 100644 --- a/.github/workflows/check-documentation.yml +++ b/.github/workflows/check-documentation.yml @@ -32,7 +32,7 @@ jobs: uses: gaurav-nelson/github-action-markdown-link-check@master with: use-quiet-mode: 'yes' - use-verbose-mode: 'no' + use-verbose-mode: 'yes' # at any .md file change take the chance to check the links in all .md files check-modified-files-only: 'no' config-file: '.github/workflows/mlc_config.json' From 82e15d43055d51c1d329b54b87d3d6ec2323ba10 Mon Sep 17 00:00:00 2001 From: mahula Date: Thu, 9 Nov 2023 14:28:12 +0100 Subject: [PATCH 5/7] fix further links in documentation --- deployment/README.md | 2 +- deployment/src/old/volumes/velero/README.md | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/deployment/README.md b/deployment/README.md index 745ab8592..7e9167fae 100644 --- a/deployment/README.md +++ b/deployment/README.md @@ -48,7 +48,7 @@ Since all deployment methods described here depend on [Docker](https://docker.co The next step is: - [Set Environment Variables and Configurations](./deployment-values.md) -- [Configure And Branding](./deployment/configurations/stage.ocelot.social/branding/README.md) +- [Configure And Branding](./configurations/stage.ocelot.social/branding/README.md) ### Optional: Locally Testing Configuration And Branding diff --git a/deployment/src/old/volumes/velero/README.md b/deployment/src/old/volumes/velero/README.md index bf63f13c8..96a9bf926 100644 --- a/deployment/src/old/volumes/velero/README.md +++ b/deployment/src/old/volumes/velero/README.md @@ -9,9 +9,9 @@ working reliably. It is very likely that DigitalOcean had some bugs when I tried out the steps below. {% endhint %} -We use [velero](https://github.com/heptio/velero) for on premise backups, we +We use [velero](https://github.com/vmware-tanzu/velero) for on premise backups, we tested on version `v0.11.0`, you can find their -documentation [here](https://heptio.github.io/velero/v0.11.0/). +documentation [here](https://github.com/vmware-tanzu/velero/releases/tag/v0.11.0). Our kubernets configurations adds some annotations to pods. The annotations define the important persistent volumes that need to be backed up. Velero will @@ -22,8 +22,8 @@ pick them up and store the volumes in the same cluster but in another namespace You have to install the binary `velero` on your computer and get a tarball of the latest release. We use `v0.11.0` so visit the -[release](https://github.com/heptio/velero/releases/tag/v0.11.0) page and -download and extract e.g. [velero-v0.11.0-linux-arm64.tar.gz](https://github.com/heptio/velero/releases/download/v0.11.0/velero-v0.11.0-linux-amd64.tar.gz). +[release](https://github.com/vmware-tanzu/velero/releases/tag/v0.11.0) page and +download and extract e.g. [velero-v0.11.0-linux-arm64.tar.gz](https://github.com/vmware-tanzu/velero/releases/download/v0.11.0/velero-v0.11.0-linux-arm64.tar.gz). ## Setup Velero Namespace From 8a60fc0870899ac55b5afa2fd4198be759ae03bd Mon Sep 17 00:00:00 2001 From: mahula Date: Thu, 9 Nov 2023 14:42:48 +0100 Subject: [PATCH 6/7] revert changes on old doc files --- deployment/src/old/digital-ocean/README.md | 2 +- deployment/src/old/volumes/neo4j-offline-backup/README.md | 2 +- deployment/src/old/volumes/velero/README.md | 8 ++++---- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/deployment/src/old/digital-ocean/README.md b/deployment/src/old/digital-ocean/README.md index ab02754ac..c5893f645 100644 --- a/deployment/src/old/digital-ocean/README.md +++ b/deployment/src/old/digital-ocean/README.md @@ -30,7 +30,7 @@ do this as a last step. We are storing our images in the s3-compatible [DigitalOcean Spaces](https://www.digitalocean.com/docs/spaces/). -We still want to take backups of our images in case something happens to the images in the cloud. See these [instructions](https://docs.digitalocean.com/products/spaces/reference/s3cmd/) about getting set up with `s3cmd` to take a copy of all images in a `Spaces` namespace, i.e. `ocelot-social-uploads`. +We still want to take backups of our images in case something happens to the images in the cloud. See these [instructions](https://www.digitalocean.com/docs/spaces/resources/s3cmd-usage/) about getting set up with `s3cmd` to take a copy of all images in a `Spaces` namespace, i.e. `ocelot-social-uploads`. After configuring `s3cmd` with your credentials, etc. you should be able to make a backup with this command. diff --git a/deployment/src/old/volumes/neo4j-offline-backup/README.md b/deployment/src/old/volumes/neo4j-offline-backup/README.md index 76dd844a2..7c34aa764 100644 --- a/deployment/src/old/volumes/neo4j-offline-backup/README.md +++ b/deployment/src/old/volumes/neo4j-offline-backup/README.md @@ -23,7 +23,7 @@ So, all we have to do is edit the kubernetes deployment of our Neo4J database and set a custom `command` every time we have to carry out tasks like backup, restore, seed etc. -First bring the application into [maintenance mode](https://github.com/Ocelot-Social-Community/Ocelot-Social/blob/master/webapp/maintenance/README.md#maintenance-mode) to ensure there are no +First bring the application into [maintenance mode](https://github.com/Ocelot-Social-Community/Ocelot-Social/blob/master/deployment/ocelot-social/maintenance/README.md) to ensure there are no database connections left and nobody can access the application. Run the following: diff --git a/deployment/src/old/volumes/velero/README.md b/deployment/src/old/volumes/velero/README.md index 96a9bf926..bf63f13c8 100644 --- a/deployment/src/old/volumes/velero/README.md +++ b/deployment/src/old/volumes/velero/README.md @@ -9,9 +9,9 @@ working reliably. It is very likely that DigitalOcean had some bugs when I tried out the steps below. {% endhint %} -We use [velero](https://github.com/vmware-tanzu/velero) for on premise backups, we +We use [velero](https://github.com/heptio/velero) for on premise backups, we tested on version `v0.11.0`, you can find their -documentation [here](https://github.com/vmware-tanzu/velero/releases/tag/v0.11.0). +documentation [here](https://heptio.github.io/velero/v0.11.0/). Our kubernets configurations adds some annotations to pods. The annotations define the important persistent volumes that need to be backed up. Velero will @@ -22,8 +22,8 @@ pick them up and store the volumes in the same cluster but in another namespace You have to install the binary `velero` on your computer and get a tarball of the latest release. We use `v0.11.0` so visit the -[release](https://github.com/vmware-tanzu/velero/releases/tag/v0.11.0) page and -download and extract e.g. [velero-v0.11.0-linux-arm64.tar.gz](https://github.com/vmware-tanzu/velero/releases/download/v0.11.0/velero-v0.11.0-linux-arm64.tar.gz). +[release](https://github.com/heptio/velero/releases/tag/v0.11.0) page and +download and extract e.g. [velero-v0.11.0-linux-arm64.tar.gz](https://github.com/heptio/velero/releases/download/v0.11.0/velero-v0.11.0-linux-amd64.tar.gz). ## Setup Velero Namespace From 1e72ce5c036786291071cc5920df34df87fcf168 Mon Sep 17 00:00:00 2001 From: mahula Date: Thu, 9 Nov 2023 14:48:01 +0100 Subject: [PATCH 7/7] set markdown link check to also ignore paths to old docs --- .github/workflows/mlc_config.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/mlc_config.json b/.github/workflows/mlc_config.json index dd9c81f3c..331ff3e11 100644 --- a/.github/workflows/mlc_config.json +++ b/.github/workflows/mlc_config.json @@ -6,7 +6,7 @@ "aliveStatusCodes": [200, 206], "ignorePatterns": [ { - "pattern": "^(https:\/\/github.com\/Ocelot-Social-Community\/Ocelot-Social\/pull\/|http:\/\/localhost)" + "pattern": "^(https:\/\/github.com\/Ocelot-Social-Community\/Ocelot-Social\/(pull|deployment\/src\/old)\/|http:\/\/localhost)" } ] }