Replace links on Codeberg to our own documentation where available #459

Ghost commented 2021年06月02日 07:38:21 +02:00

The SSH / GPG guide in the user setting section points to Github documentation even thought a page for adding SSH keys to one's account exists in the Codeberg documentation.

<!-- NOTE: If your issue is a security concern, please send an email to contact@codeberg.org (and if related to Gitea also to security@gitea.io) instead of opening a public issue. Thank you. Welcome to the Codeberg Community Tracker. This is the right place for bug reports, feature requests and feedback. It's the central place where we track progress and discuss, so please open issues here unless you are sure it's directly related to a specific Codeberg product and only some contributors there need to join the discussion. Easy rule: If you are unsure, report it here. When reporting bugs or asking for features in the software itself, please understand that Codeberg is a fork of Gitea. Please always check upstream (→ see FAQ) if your there is already an open issue. If not, you'd really help us if you could directly get in touch with the maintainers and open an issue here if you think a wider audience should know about that (e. g. when discussing hotfixes, backports or when discussing whether some feature should become part of Gitea or a Codeberg "add-on"). If you don't have a GitHub account, please mention this and we'll gladly forward your report to the Gitea maintainers. Thank you for reporting your findings and giving feedback on Codeberg. ## Some FAQ: ### What does upstream mean? Upstream refers to Gitea, the software Codeberg is built upon. If we ask you if you can report upstream, please visit https://github.com/go-gitea/gitea/issues and check for the bug there and report elsewise. It's usually good if the person interested in a feature or bugfix opens the request to react to questions and join the discussion. We would usually just fire the report, but won't find the time to properly react to that ... **If you do not have a GitHub account**, just tell us and we'll happily forward the report for you. ### I just noticed a typo in the sign_up / sing_up route when regis... No, this is not a typo, but intentional. It was a quick fix to avoid spammers targetting our instance and it actually worked out quite well to rename the route from sign_up to sing_up (few people notice, nice to see you have sharp eyes) ... we might have to take more effective countermeasures in the future, but for now we're actually quite good with that one ... ### How can I help? If you want to help improving Codeberg as a community home for software development, we'll gladly welcome your contribution. Check out the docs about improving Codeberg https://docs.codeberg.org/improving-codeberg/ and have a look at the open issues, especially those that are looking for contribution https://codeberg.org/Codeberg/Community/issues?state=open&labels=105 - some of them don't even require much coding knowledge. We are also happy if you forward bug reports to Gitea if the original author hasn't done that yet or hasn't got a GitHub account. --> The SSH / GPG guide in the user setting section points to Github documentation even thought a page for adding SSH keys to one's account exists in the Codeberg documentation.

n commented 2021年06月02日 09:53:19 +02:00

See Codeberg/Documentation#91. Ideally I'd like to fix all currently open issues regarding the SSH article before we link it. Contributions are welcome!

See Codeberg/Documentation#91. Ideally I'd like to fix all currently open issues regarding the SSH article before we link it. Contributions are welcome!

fnetX commented 2021年06月02日 13:12:10 +02:00

I wanted to look into this already. Currently, even Gitea is sometimes linking to GitHub's docs, although their own ones are more feature-complete now.

This makes sense both upstream and downstream, not sure if we should look into the former. But for Codeberg, we should change some links, most importantly "Help" from the user menu should point to our docs.

I wanted to look into this already. Currently, even Gitea is sometimes linking to GitHub's docs, although their own ones are more feature-complete now. This makes sense both upstream and downstream, not sure if we should look into the former. But for Codeberg, we should change some links, most importantly "Help" from the user menu should point to our docs.

fnetX commented 2021年06月14日 15:47:11 +02:00

Not sure who pointed me to the thread and / or where this was mentioned, but I proposed to land this upstream: https://github.com/go-gitea/gitea/issues/15736

If this happens, we might want to revise the docs once more (Codeberg/Documentation#134) and maybe find a way to cover Gitea-features different to Codeberg (e.g. disabled stuff). Tiny stuff can be mentioned inline, whole disabled features could be moved into a "Your own Gitea" category or something ...

Let's wait what the upstream guys think, and decide for the next steps then.

Not sure who pointed me to the thread and / or where this was mentioned, but I proposed to land this upstream: https://github.com/go-gitea/gitea/issues/15736 If this happens, we might want to revise the docs once more (https://codeberg.org/Codeberg/Documentation/issues/134) and maybe find a way to cover Gitea-features different to Codeberg (e.g. disabled stuff). Tiny stuff can be mentioned inline, whole disabled features could be moved into a "Your own Gitea" category or something ... Let's wait what the upstream guys think, and decide for the next steps then.

fnetX commented 2021年06月15日 16:08:12 +02:00

Roadmap:

• evaluate which links in the Gitea templates still point non-CB-docs resources
  • collect them in Codeberg/Documentation#134
  • make sure they are covered
• find a way to welcome users of plain Gitea in our docs (e.g. a dedicated Gitea landing page)
• replace links in the templates with pointers to our docs, upstream help should point to a Gitea landing page (either in our docs or theirs), Codeberg should point to our Getting started

After this, we can make sure to stay in sync with upstream and eventually find a way to make our Documentation content integrate nice with their own docs.

Roadmap: - [x] evaluate which links in the Gitea templates still point non-CB-docs resources - [ ] collect them in https://codeberg.org/Codeberg/Documentation/issues/134 - [ ] make sure they are covered - [ ] find a way to welcome users of plain Gitea in our docs (e.g. a dedicated Gitea landing page) - [ ] replace links in the templates with pointers to our docs, upstream help should point to a Gitea landing page (either in our docs or theirs), Codeberg should point to our Getting started After this, we can make sure to stay in sync with upstream and eventually find a way to make our Documentation content integrate nice with their own docs.

n commented 2021年06月17日 12:10:29 +02:00

Locations of links that point to non-Codeberg Docs:

• User settings
  • SSH keys
  • GPG keys
• Migration
  • Gitea access token (Codeberg/gitea#20)
• Navbar
  • Help (under profile and settings)
  • Help (when logged out)
• Repo
  • New Repository

    A license governs what others can and can't do with your code. Not sure which one is right for your project? See Choose a license.

  • Empty Repo Quick Guide

    "Need help cloning? Visit Help."

  • Settings
    • Webhooks

Locations of links that point to non-Codeberg Docs: - User settings - SSH keys - GPG keys - Migration - Gitea access token (Codeberg/gitea#20) - Navbar - Help (under profile and settings) - Help (when logged out) - Repo - New Repository > A license governs what others can and can't do with your code. Not sure which one is right for your project? See [Choose a license.](https://choosealicense.com/) - Empty Repo Quick Guide > "Need help cloning? Visit [Help](http://git-scm.com/book/en/Git-Basics-Getting-a-Git-Repository)." - Settings - Webhooks

faustzero1 commented 2022年05月17日 19:59:28 +02:00

Roadmap:

• evaluate which links in the Gitea templates still point non-CB-docs resources
  • collect them in Codeberg/Documentation#134
  • make sure they are covered
• find a way to welcome users of plain Gitea in our docs (e.g. a dedicated Gitea landing page)
• replace links in the templates with pointers to our docs, upstream help should point to a Gitea landing page (either in our docs or theirs), Codeberg should point to our Getting started

After this, we can make sure to stay in sync with upstream and eventually find a way to make our Documentation content integrate nice with their own docs.

So now what?
I'm still a little confused here..., Can we create our own (Specific) Docs and then do some pull requests to change the URL of the link that refers to our Docs?

> Roadmap: > - [x] evaluate which links in the Gitea templates still point non-CB-docs resources > - [ ] collect them in https://codeberg.org/Codeberg/Documentation/issues/134 > - [ ] make sure they are covered > - [ ] find a way to welcome users of plain Gitea in our docs (e.g. a dedicated Gitea landing page) > - [ ] replace links in the templates with pointers to our docs, upstream help should point to a Gitea landing page (either in our docs or theirs), Codeberg should point to our Getting started > > After this, we can make sure to stay in sync with upstream and eventually find a way to make our Documentation content integrate nice with their own docs. So now what? I'm still a little confused here..., Can we create our own (Specific) Docs and then do some pull requests to change the URL of the link that refers to our Docs?

fnetX commented 2024年02月28日 01:11:36 +01:00

With the existence of Forgejo, it is in some places acceptable to link to the Forgejo docs IMHO.

With the existence of Forgejo, it is in some places acceptable to link to the Forgejo docs IMHO.