Codeberg/Documentation
43
151
Fork
You've already forked Documentation
129

FeatureRequest: prominent reading access to this wiki #7

Closed
opened 2019年07月10日 10:28:37 +02:00 by buhtz · 19 comments

This is for the future when the Wiki grows and become more valuable than today.

Codebergs landing page and the blue menu bar need a link to Codebergs own documentation (this wiki?).

Also in the settings section "SSH / GPG keys" are links to GitHub's SSH help sizes.

On codeberg's landing page is a "Help" link just pointing to the gitea docu.

This is for the future when the Wiki grows and become more valuable than today. Codebergs landing page and the blue menu bar need a link to Codebergs own documentation (this wiki?). Also in the settings section "SSH / GPG keys" are links to GitHub's SSH help sizes. On codeberg's landing page is a "Help" link just pointing to the gitea docu.
Owner
Copy link

As soon we are happy with the content, we shall definitely do this! In preparation of a PR, please see the template file in https://codeberg.org/Codeberg/build-deploy-gitea/src/branch/master/etc/gitea/templates/custom/extra_links.tmpl.

As soon we are happy with the content, we shall definitely do this! In preparation of a PR, please see the template file in https://codeberg.org/Codeberg/build-deploy-gitea/src/branch/master/etc/gitea/templates/custom/extra_links.tmpl.
Owner
Copy link

I also added a link to the Community issue tracker landing page: https://codeberg.org/Codeberg/Community/src/branch/master/README.md

I also added a link to the Community issue tracker landing page: https://codeberg.org/Codeberg/Community/src/branch/master/README.md
Author
Copy link

Can you deactivate the "Wiki" menu entry in "Codeberg/Community"?

Because we are using the "Codeberg/Documentation" wiki.

Or should we overthink this in general? As a DAU I would assume the codeberg docu in the general "Codeberg repository" what is in fact "Codeberg/Community" because the "Codeberg Issues Tracker" menu entry on the landing page pointing to there.

Can you deactivate the "Wiki" menu entry in "Codeberg/Community"? Because we are using the "Codeberg/Documentation" wiki. Or should we overthink this in general? As a DAU I would assume the codeberg docu in the general "Codeberg repository" what is in fact "Codeberg/Community" because the "Codeberg Issues Tracker" menu entry on the landing page pointing to there.
Owner
Copy link

I agree with you. Moving these into the community wiki seems appropriate and improves user experience. @all: Any thoughts on this?

I agree with you. Moving these into the community wiki seems appropriate and improves user experience. @all: Any thoughts on this?
Author
Copy link

No other thoughts, so we can do it? ;)

No other thoughts, so we can do it? ;)
Owner
Copy link

hehe, looks like it :)

hehe, looks like it :)
Author
Copy link

I am not familiar with gitea or what ever is needed to modify the link son the landing page.
Some other person need to do this job. ;)

I am not familiar with gitea or what ever is needed to modify the link son the landing page. Some other person need to do this job. ;)
Owner
Copy link

should we overthink this in general

open to this too. Now that we have https://pages.codeberg.org/ and wiki content in markdown format, we might also consider alternative approaches that allow a more flexible layout?

Either way, improved content is probably more important than formatting we can update at any time...

I am not familiar with gitea or what ever is needed to modify the link son the landing page. Some other person need to do this job. ;)

I disabled the wiki tab in the Community repo.

> should we overthink this in general open to this too. Now that we have https://pages.codeberg.org/ and wiki content in markdown format, we might also consider alternative approaches that allow a more flexible layout? Either way, improved content is probably more important than formatting we can update at any time... > I am not familiar with gitea or what ever is needed to modify the link son the landing page. Some other person need to do this job. ;) I disabled the wiki tab in the Community repo.
Contributor
Copy link

@hw I would be happy to help and design a nice and friendly documentation page rendered from the Markdown.

I suggest we use Eleventy for generating the final HTML.
It's a very flexible, minimalistic static site generator that works well with all kinds of inputs, including Markdown. I've been using it for my personal website and the experience so far was great.

If you're interested, I can build a quick prototype and report back :)

(Don't mind me, I'm just a reference to track the progress in the related issue in the Community repo: Codeberg/Community#33 🤓)

@hw I would be happy to help and design a nice and friendly documentation page rendered from the Markdown. I suggest we use [Eleventy](https://www.11ty.dev/) for generating the final HTML. It's a very flexible, minimalistic static site generator that works well with all kinds of inputs, including Markdown. I've been using it for my personal website and the experience so far was great. If you're interested, I can build a quick prototype and report back :) <sub>(Don't mind me, I'm just a reference to track the progress in the related issue in the Community repo: https://codeberg.org/Codeberg/Community/issues/33 🤓)</sub>
Owner
Copy link

@lhinderberger : Have you seen this? #13

ping @n

@lhinderberger : Have you seen this? https://codeberg.org/Codeberg/Documentation/pulls/13 ping @n
Contributor
Copy link

No, haven't seen that yet - but great to see it's already being done :)

No, haven't seen that yet - but great to see it's already being done :)
Contributor
Copy link

With #36 resolved, we can now think about whether we want to add a link to the documentation site https://docs.codeberg.org to the navigation bar or whether we want to wait until the Getting Started guide #26 is done.

With #36 resolved, we can now think about whether we want to add a link to the documentation site https://docs.codeberg.org to the navigation bar or whether we want to wait until the Getting Started guide #26 is done.
Owner
Copy link
PR to templates in https://codeberg.org/Codeberg/build-deploy-gitea/src/branch/master/etc/gitea/templates/custom/ welcome!
Contributor
Copy link

Will do. But should we wait until the Getting Started guide is ready (approx. at the end of the week)?

Will do. But should we wait until the Getting Started guide is ready (approx. at the end of the week)?
Contributor
Copy link

With #36 resolved, we can now think about whether we want to add a link to the documentation site https://docs.codeberg.org to the navigation bar

The nav bar is already quite crowded. We could replace Codeberg Issues with a link to the docs.

Will do. But should we wait until the Getting Started guide is ready (approx. at the end of the week)?

Sounds good to me. A blog post about the documentation would be good too!

> With #36 resolved, we can now think about whether we want to add a link to the documentation site https://docs.codeberg.org to the navigation bar The nav bar is already quite crowded. We could replace Codeberg Issues with a link to the docs. > Will do. But should we wait until the Getting Started guide is ready (approx. at the end of the week)? Sounds good to me. A [blog post](https://codeberg.org/Codeberg/blog) about the documentation would be good too!
Contributor
Copy link

We could replace Codeberg Issues with a link to the docs.

I would rather combine "Join Codeberg e.V." and "Donate" into "Support Codeberg" and leave "Codeberg Issues" in the menu, because Issues is a good way to get into contact and is very frequently used. As it serves more or less as a forum, it shouldn't be removed IMHO.

A blog post about the documentation would be good too!

Agreed 👍

> We could replace Codeberg Issues with a link to the docs. I would rather combine "Join Codeberg e.V." and "Donate" into "Support Codeberg" and leave "Codeberg Issues" in the menu, because Issues is a good way to get into contact and is very frequently used. As it serves more or less as a forum, it shouldn't be removed IMHO. > A [blog post](https://codeberg.org/Codeberg/blog) about the documentation would be good too! Agreed 👍
Contributor
Copy link

With the Getting Started Guide now deployed, I'd usually write a pull request to build-deploy-gitea, but with Codeberg/Community#140 being unresolved, I'm unsure whether that would really be a good idea.

How should we move forward?

With the Getting Started Guide now deployed, I'd usually write a pull request to build-deploy-gitea, but with Codeberg/Community#140 being unresolved, I'm unsure whether that would really be a good idea. How should we move forward?
Contributor
Copy link

The PR linked above now adds a basic link to the title bar, in the style we use right now. This is not the ideal solution for horizontal growth and might be rejected because of that. But on the other hand it's better to have a link there now than to have no link at all.

The PR linked above now adds a basic link to the title bar, in the style we use right now. This is not the ideal solution for horizontal growth and might be rejected because of that. But on the other hand it's better to have a link there now than to have no link at all.
Contributor
Copy link

The link to Documentation has now been deployed to the main page :)

The link to Documentation has now been deployed to the main page :)
Sign in to join this conversation.
No Branch/Tag specified
main
git-pages
pr-554
pr/554
gitea-icons-shortcode
No results found.
Labels
Clear labels
Codeberg Pages

Issues affecting Codeberg Pages
Documentation Usability

Issues related to using and reading docs.codeberg.org
Forgejo
Good First Issue! 👋
Kind: Bug
Kind: Documentation
Kind: Enhancement
Kind: Feature
Kind: Question
Kind: Security
Licensing
Part: Generator

This is related to the generation of the documentation, not to the content itself
Priority: High

The priority is high
Priority: Low

The priority is low
Priority: Medium

The priority is medium
Reviewed: Confirmed

Something has been confirmed
Reviewed: Duplicate

Something exists already
Reviewed: Invalid

Something was marked as invalid
Reviewed: Wontfix

Something won't be fixed
Status: Blocked
Status: Help wanted

Contributions are welcome!
Status: In progress

Work is in progress
Status: Needs feedback

Feedback is needed
Status: Ready for Review

Work is completed
Status: Review

Review is in progress / Reviewers wanted
Status: Stale
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
4 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Blocks Depends on
Reference
Codeberg/Documentation#7
Reference in a new issue
Codeberg/Documentation
No description provided.
Delete branch "%!s()"

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?