Codeberg/Documentation
42
199
Fork
You've already forked Documentation
161

Document how to use Codeberg Pages #27

Closed
opened 2020年08月13日 13:05:03 +02:00 by lhinderberger · 15 comments
Contributor
Copy link

We should add a section on how to use Codeberg Pages and link to it from pages.codeberg.org

We should add a section on how to use Codeberg Pages and link to it from pages.codeberg.org
Author
Contributor
Copy link

I think this should be the next section to focus on, because currently, there's not even a link to pages.codeberg.org from the Codeberg site, which makes this very nice service a bit hard to find in the beginning.

I think this should be the next section to focus on, because currently, there's not even a link to pages.codeberg.org from the Codeberg site, which makes this very nice service a bit hard to find in the beginning.
Author
Contributor
Copy link

Also, it might be worth losing a few words about it in the Getting Started section.

Also, it might be worth losing a few words about it in the Getting Started section.
Owner
Copy link

We need to finally launch <username>.codeberg.eu subdomain support on codeberg main.

We need to finally launch `<username>.codeberg.eu` subdomain support on codeberg main.
Author
Contributor
Copy link

See also #95, which gives information about the new codeberg.page domain and the future of pages.codeberg.org.

See also #95, which gives information about the new codeberg.page domain and the future of pages.codeberg.org.
Author
Contributor
Copy link

@hw - With codeberg.page launched, what will be the fate of codeberg.eu?

@hw - With codeberg.page launched, what will be the fate of codeberg.eu?
Owner
Copy link

It is still linked to codeberg-test, so that everything can be tested there, too (including fonts delivery, badges, etc).

We discovered the .page TLD only late, but it seems a much better fit from the perspective of the casual user. Still, knowing that .eu is administered in our jurisdiction, is soothing. (Still, we might not want to signal that codeberg is a EU-only affair, even if we have a strong focus here?). Depending on general feedback we might:

  • run it in parallel to .page, and leave the choice to the user what to publish,
  • keep it as testing domain and fallback if ever needed.

If there are any preferences please all raise your voice, if appropriate we will organize a poll for decision.

It is still linked to codeberg-test, so that everything can be tested there, too (including fonts delivery, badges, etc). We discovered the .page TLD only late, but it seems a much better fit from the perspective of the casual user. Still, knowing that .eu is administered in our jurisdiction, is soothing. (Still, we might not want to signal that codeberg is a EU-only affair, even if we have a strong focus here?). Depending on general feedback we might: - run it in parallel to .page, and leave the choice to the user what to publish, - keep it as testing domain and fallback if ever needed. If there are any preferences please all raise your voice, if appropriate we will organize a poll for decision.
Owner
Copy link

Please also see Codeberg/Community#303

Please also see https://codeberg.org/Codeberg/Community/issues/303
Contributor
Copy link

I just today discovered that https://codeberg.page/ exists, so yes, documentation would be great :-)

I just today discovered that https://codeberg.page/ exists, so yes, documentation would be great :-)
Author
Contributor
Copy link

Contributions are super welcome :)

Contributions are super welcome :)
Contributor
Copy link

First attempt: #98

First attempt: https://codeberg.org/Codeberg/Documentation/pulls/98
Author
Contributor
Copy link

With #98 merged, we now have a starting point, using which Pages can be found :)
Thank you @hjacobs!

I'll leave this issue open though, with Priority: High removed, because the next steps would be to go into greater detail about the capabilities and limitations of Pages. For beginners, it might also be a good idea to provide a tutorial and links to static site generators.

With #98 merged, we now have a starting point, using which Pages can be found :) Thank you @hjacobs! I'll leave this issue open though, with `Priority: High` removed, because the next steps would be to go into greater detail about the capabilities and limitations of Pages. For beginners, it might also be a good idea to provide a tutorial and links to static site generators.
Contributor
Copy link

@lhinderberger awesome thanks!

@lhinderberger awesome thanks!
Contributor
Copy link

Adding on, providing basic scripts examples for building static sites would be helpful:

Adding on, providing basic scripts examples for building static sites would be helpful: - Here's the one used on the Docs: [deploy.sh](https://codeberg.org/Codeberg/Documentation/src/branch/master/deploy.sh) - and here's one provided by @momar for the next version of pages: [Comment on Codeberg/Community#410](https://codeberg.org/Codeberg/Community/issues/410#issuecomment-198362) - Build scripts for Drone: Codeberg/Community#498

We have a pages documentation nowadays at https://docs.codeberg.org/codeberg-pages/

But afaik it is outdated as the "new" pages implementation does not need a pages repo anymore - but this should be handled in a separate issue, maybe #51

We have a pages documentation nowadays at https://docs.codeberg.org/codeberg-pages/ But afaik it is outdated as the "new" pages implementation does not need a `pages` repo anymore - but this should be handled in a separate issue, maybe #51
Owner
Copy link

IMHO, we should document the pages server behaviour at codeberg.page (e.g. long onepager or subsections there).

It's really hard to keep up2date with what Pages maintainers do, and they also sometimes don't know what their services does and break existing features. IMHO they should take over the responsibility for maintaining proper docs. Also, many users are confused and don't look at the docs.

IMHO, we should document the pages server behaviour at codeberg.page (e.g. long onepager or subsections there). It's really hard to keep up2date with what Pages maintainers do, and they also sometimes don't know what their services does and break existing features. IMHO they should take over the responsibility for maintaining proper docs. Also, many users are confused and don't look at the docs.
Sign in to join this conversation.
No Branch/Tag specified
main
renovate/mstruebing-editorconfig-checker-3.x
renovate/lycheeverse-lychee-0.x
renovate/markdownlint-cli2-0.x
renovate/markdown-it-14.x
renovate/davidanson-markdownlint-cli2-0.x
renovate/node-lts-slim
renovate/npm-pnpm-vulnerability
ci_pr_close_no_preview
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
6 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
Codeberg/Documentation#27
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?