From fbd697dc1b7090920665c3bafa141976d9aeb98b Mon Sep 17 00:00:00 2001 From: mahula Date: Thu, 9 Nov 2023 10:53:26 +0100 Subject: [PATCH] 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.