FeatureRequest: prominent reading access to this wiki #7

Closed
opened 3 years ago by buhtz · 19 comments
buhtz commented 3 years ago

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

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

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
Poster

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

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?
Poster

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

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

hehe, looks like it :)

hehe, looks like it :)
Poster

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

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.

@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

@lhinderberger : Have you seen this? #13

ping @n

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

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 :)
lhinderberger added the
Kind: Feature
Status: In progress
labels 2 years ago
lhinderberger added
Status: Blocked
and removed
Status: In progress
labels 2 years ago
lhinderberger added
Status: Needs feedback
and removed
Status: Blocked
labels 2 years ago

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
PR to templates in https://codeberg.org/Codeberg/build-deploy-gitea/src/branch/master/etc/gitea/templates/custom/ welcome!

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)?
n commented 2 years ago
Collaborator

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!

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 👍

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?
lhinderberger added the
Priority: High
label 2 years ago

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.

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

The link to Documentation has now been deployed to the main page :)
lhinderberger closed this issue 2 years ago
Sign in to join this conversation.
No Milestone
No Assignees
4 Participants
Notifications
Due Date

No due date set.

Blocks Depends on
Reference: Codeberg/Documentation#7
Loading…
There is no content yet.