This adds a Documentation for connecting Codeberg to Read the Docs. English is not my native Language, so there may be a few things that could be written better.
@ -0,0 +5,4 @@
parent: Integrations
---
This article will guide you through integrating Codeberg with [Read the Docs](https://readthedocs.org/) to allow automatic build of your Documentation. It will show you, how to connect Read the Docs to a Codeberg Repository. To learn how Read the DOcs works, take a loot at the [official Documentation](https://docs.readthedocs.io).
*Docs
loot -> look
@ -0,0 +14,4 @@
1. On Read the Docs click "Import a Project"
2. If you have connected Read the Docs with some Provider e.g. GitHub, you see a list of your Repos at that provider. Ignore it and click "Import Manually"
3. You should see this screen:
Step three is not really a step, is it? It interrupts the flow IMHO. Please also ensure that you write in a way that allows to follow even without pictures (they might be disabled in low-spec machines or not accessible to readers with limited or missing eye vision).
You can use screenshots to better convey your information, though. But I think they should be described differently.
I don't know how to describe this better, but the Screenshot is optional.It just for people to confirm they are on the right screen. If you just follow the steps, everything should be fine.
I added some proposals for the alt-attribute of the image tag.
You may use or adapt them as you see fit.
Thank you.
@ -0,0 +7,4 @@
This article will guide you through integrating Codeberg with [Read the Docs](https://readthedocs.org/) to allow automatic build of your Documentation. It will show you, how to connect Read the Docs to a Codeberg Repository. To learn how Read the DOcs works, take a loot at the [official Documentation](https://docs.readthedocs.io).
> Gitea/Forgeo is currenly not official supported by Read the Docs, so this may break in the future
Forgeo -> Forgejo
@ -0,0 +29,4 @@
<img src="/assets/images/integrations/read-the-docs/admin-integrations.png" alt="webhooks">
</picture>
6. Now click on "Add Integregration" and select "GitHub incoming webhook" as type. You should see this Screen:
Integregration -> Integration
f26bad3e00
to b5d33c6025
@JakobDev can you grant me push access to your fork? I'd like to make some spelling adjustments that are tedious to create a review for.
Does the integration work for private repos as well?
can you grant me push access to your fork?
I though you already have write access, because of I allow edit edits from maintainers in this PR, but you are now added.
Does the integration work for private repos as well?
That's a good question. I haven't tested it yet, but I don't think so. Read the Docs needs access to the Git Repo and is build for OpenSource Projects.
@ -0,0 +10,4 @@
> Gitea/Forgejo is currenly not official supported by Read the Docs, so this may break in the future
## Create new Project
This steps shows how to create a new Project on Read the Docs
Thank you for this documentation!
I think you should add there that you need to have an account with readthedocs and that you must be signed in before being able to click on "Import a project" on the dashboad (https://readthedocs.org/dashboard/).
E.g. add a section:
## Registration
If you do not have an account yet, you must sign up with [readthedocs first](https://readthedocs.org/accounts/signup/).
After sign-up you need to login with your user to access your [dashboard](https://readthedocs.org/dashboard/).
@ -0,0 +12,4 @@
## Create new Project
This steps shows how to create a new Project on Read the Docs
1. On Read the Docs click "Import a Project"
I would rephrase it to:
1. On the [Read the Docs dashboard](https://readthedocs.org/dashboard/) click "Import a Project"
I accidentally approved before, so please see all of my comments as "request for change".
@ -0,0 +48,4 @@
<picture>
<source srcset="/assets/images/integrations/read-the-docs/add-webhook.webp" type="image/webp">
<img src="/assets/images/integrations/read-the-docs/add-webhook.png" alt="webhooks">
As already mentioned by @fnetX it would be great to have an alternate text for the images used.
E.g.:
instead of alt="webooks" one could use
alt="Image of the Forgejo 'Add Webhook' dialog. The input field for 'Target URL' is marked with a red border. Also the 'All Events' checkout below the 'Trigger On' section is marked with a red border."
That would help a lot.
@ -0,0 +25,4 @@
<picture>
<source srcset="/assets/images/integrations/read-the-docs/admin-integrations.webp" type="image/webp">
<img src="/assets/images/integrations/read-the-docs/admin-integrations.png" alt="webhooks">
Proposal for an alternative alt-attribute text:
Image of an admin website of a Read the docs project.
The integrations section of the admin page is selected.
The content of the Integrations sections states, that 'No integrations are currently configured.'.
An error message is shown in red saying that the project does not have a valid webhook set up.
@ -0,0 +32,4 @@
<picture>
<source srcset="/assets/images/integrations/read-the-docs/github-integration.webp" type="image/webp">
<img src="/assets/images/integrations/read-the-docs/github-integration.png" alt="webhooks">
Proposal for an alternative alt-attribute text:
Image of an admin website of a Read the docs project.
The integrations section of the admin page is selected.
The page content start with a header saying 'Integration - GitHub incoming webhook'.
After some explaining text an url specific to the Read the docs project is shown which can be used to manually configure this webhook.
The url shown is marked with a red border.
@ -0,0 +40,4 @@
<picture>
<source srcset="/assets/images/integrations/read-the-docs/forgejo-webhook.webp" type="image/webp">
<img src="/assets/images/integrations/read-the-docs/forgejo-webhook.png" alt="webhooks">
Propsal for an alternative alt-attribute text:
Image of a Forgejo repository configuration.
The tab 'Webhooks' is selected.
The button 'Add Webhook' has been clicked and presents a list of possible Webhooks integrations.
The 'Forgejo' entry in the list has been marked with a red border.
Thanks for your contribution!
No due date set.
No dependencies set.
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?