diff --git a/LICENSE.md b/LICENSE.md index da71008..d9dbe50 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -8,4 +8,6 @@ looked up in [https://codeberg.org/Codeberg/Documentation/commits/branch/master] The Codeberg logos in this website are by mray, licensed under [CC-BY 4.0](https://creativecommons.org/licenses/by/4.0/deed.en). -Codeberg and the Codeberg Logo are trademarks of Codeberg e.V. \ No newline at end of file +Codeberg and the Codeberg Logo are trademarks of Codeberg e.V. + +"Knut the Polar Bear" has been derived from https://openclipart.org/detail/193243/polar-bear-remix, under CC0 1.0 diff --git a/assets/images/getting-started/first-steps/dashboard.png b/assets/images/getting-started/first-steps/dashboard.png new file mode 100644 index 0000000..0056307 Binary files /dev/null and b/assets/images/getting-started/first-steps/dashboard.png differ diff --git a/assets/images/getting-started/first-steps/dashboard.webp b/assets/images/getting-started/first-steps/dashboard.webp new file mode 100644 index 0000000..f280bda Binary files /dev/null and b/assets/images/getting-started/first-steps/dashboard.webp differ diff --git a/assets/images/getting-started/first-steps/register.png b/assets/images/getting-started/first-steps/register.png new file mode 100644 index 0000000..10a2d94 Binary files /dev/null and b/assets/images/getting-started/first-steps/register.png differ diff --git a/assets/images/getting-started/first-steps/register.webp b/assets/images/getting-started/first-steps/register.webp new file mode 100644 index 0000000..a79c6b0 Binary files /dev/null and b/assets/images/getting-started/first-steps/register.webp differ diff --git a/assets/images/getting-started/issue-tracking-basics/issues-list.png b/assets/images/getting-started/issue-tracking-basics/issues-list.png new file mode 100644 index 0000000..f939761 Binary files /dev/null and b/assets/images/getting-started/issue-tracking-basics/issues-list.png differ diff --git a/assets/images/getting-started/issue-tracking-basics/issues-list.webp b/assets/images/getting-started/issue-tracking-basics/issues-list.webp new file mode 100644 index 0000000..bb77697 Binary files /dev/null and b/assets/images/getting-started/issue-tracking-basics/issues-list.webp differ diff --git a/assets/images/getting-started/knut.svg b/assets/images/getting-started/knut.svg new file mode 100644 index 0000000..a4189d3 --- /dev/null +++ b/assets/images/getting-started/knut.svg @@ -0,0 +1 @@ +image/svg+xmlOpenclipart diff --git a/content/collaborating/index.md b/content/collaborating/index.md index 136f98d..4d9a104 100644 --- a/content/collaborating/index.md +++ b/content/collaborating/index.md @@ -6,5 +6,9 @@ eleventyNavigation: order: 30 --- -These documentation pages contain information on how you can collaborate on Codeberg, -for example [by making Pull Requests](/collaborating/pull-requests-and-git-flow). \ No newline at end of file +These documentation pages contain detailed information on how you can collaborate +on Codeberg, for example [by making Pull Requests](/collaborating/pull-requests-and-git-flow). + +If you're new to Codeberg or software forges in general, please also have a look at +our [Getting Started Guide](/getting-started) which will teach you the basics of +issue tracking and wikis on Codeberg. \ No newline at end of file diff --git a/content/getting-started/creating-account.md b/content/getting-started/creating-account.md deleted file mode 100644 index f33971d..0000000 --- a/content/getting-started/creating-account.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -eleventyNavigation: - key: CreatingAccount - title: Creating an Account - parent: GettingStarted - order: 20 - draft: true ---- diff --git a/content/getting-started/first-steps.md b/content/getting-started/first-steps.md new file mode 100644 index 0000000..660337b --- /dev/null +++ b/content/getting-started/first-steps.md @@ -0,0 +1,71 @@ +--- +eleventyNavigation: + key: FirstSteps + title: Your First Steps on Codeberg + parent: GettingStarted + order: 20 +--- + +## Registering at Codeberg.org + + + Register + + +To create your account at Codeberg.org, visit [https://codeberg.org](https://codeberg.org) +and click on "Register" to bring up the registration form. + +There, simply fill in your username and email address and then choose a good password. + +After confirming your email address by clicking the link that we sent you to your +email account, you're done and good to go! + + +## Community +Codeberg is a non-profit volunteer effort. It relies on its friendly and dedicated community. We're happy that you're now a part of our community, too, and we hope you're feeling welcome! + +We kindly ask you to be polite and civil when on Codeberg and to not excessively use the resources provided. Please see our [Terms of Use](https://codeberg.org/codeberg/org/src/branch/master/TermsOfUse.md) for details. + +Please remember that everyone here is contributing on their free time, as volunteers. + +If you like a project on Codeberg, consider **giving it a star** and/or **following its author**. That helps building and growing a network of free software projects and people and can serve as guidance for users exploring Codeberg, looking for interesting projects to try out or contribute to. + + +## Orienting yourself on Codeberg +After successfully registering on Codeberg, you should see this screen: + + + + Dashboard + + +An explanation of the highlighted elements above: + +- **Dashboard (1)** is the screen you're looking at right now. It gives you an overview of the newest activity + of you, the people you follow and in your or your organization's projects. +- **Issues (2)** and **Pull Requests (3)** These are overviews of issues and pull requests that you are either involved in or that are part of one of the organizations you belong to. +- **Codeberg Issues (4)** This is currently the primary communication channel for the Codeberg Community. Here, you can ask questions, report bugs and suggest changes to Codeberg. You're also welcome to browse these issues and contribute your solutions, if you want to support Codeberg even more. +- **The Create Menu (5)** You can create repositories, organizations and migrations using this menu. It's your entry point to kicking off entirely new things on Codeberg. +- **Your Avatar (6)** will lead you to a menu, where you can look at your profile, edit your settings, view the documentation of Gitea (the software Codeberg is based on) or log out. +- **The Dashboard Context Switcher (7)** If you're part of one or more organizations, you can use this context switcher to let the dashboard display information relevant to the organization, rather than your account. + + +## A word about Security +While it is important to choose a strong password, it is also +important to use Two-factor Authentication in case your password or device +ever gets compromised, so that should be one of the first things to +configure after you have created your account. + +We recommend that you use Two-factor Authentication on your account, to increase +your security. + +> Please visit the [guide in the security section](/security/2fa) to learn how to set up 2FA. + + +## Moving on from here +Now that you have an account on Codeberg.org, you can choose from a number of possible ways to explore: + +- [Create your first Repository](/getting-started/first-repository) +- [Report or Comment on an Issue](/getting-started/issue-tracking-basics) +- [Learn how to use Git](/git) and then [Contribute a Pull Request](/collaborating/pull-requests-and-git-flow) +- [Contribute to Codeberg](/improving-codeberg) \ No newline at end of file diff --git a/content/getting-started/index.md b/content/getting-started/index.md index feb555a..db3ea8c 100644 --- a/content/getting-started/index.md +++ b/content/getting-started/index.md @@ -6,12 +6,14 @@ eleventyNavigation: order: 10 description: This article shows you how to get started with Codeberg --- +Knut the Polar Bear Hello there! -We're glad you're considering to join [Codeberg, the community-driven non-profit -software development platform](/getting-started/what-is-codeberg). +We're glad you're considering to join Codeberg, the community-driven non-profit software development platform. -These pages will guide you through your first steps on Codeberg. +I'm Knut the Polar Bear, and I'm going to guide you through your first steps on Codeberg. -You can start with [creating an account](/getting-started/creating-account). If you already have an account, please continue with [creating your first repository](/getting-started/first-repository). \ No newline at end of file +You can start with [finding out more about Codeberg](/getting-started/what-is-codeberg) or by jumping right to [your first steps on Codeberg](/getting-started/first-steps). + +Welcome to Codeberg! 😊 \ No newline at end of file diff --git a/content/getting-started/issue-tracking-basics.md b/content/getting-started/issue-tracking-basics.md new file mode 100644 index 0000000..3e75aa0 --- /dev/null +++ b/content/getting-started/issue-tracking-basics.md @@ -0,0 +1,99 @@ +--- +eleventyNavigation: + key: IssueTrackingBasics + title: The Basics of Issue Tracking + parent: GettingStarted + order: 40 +--- + +Issues are an important mean of communication on Codeberg. +Besides their original purpose - reporting bugs to a project's maintainer - +they can be used to suggest enhancements, ask for new features, discuss a project's +direction, ask questions and much more. + +### The Issue Tracker + + + Issues List + + +You can find the issue tracker of a project by clicking its "Issues" tab (1). + +There, you will see browseable and filterable (2) list of all issues. +Many projects use labels to categorize issues. A good label to look for, if you want +to contribute to a project is the "help wanted" label. + +You can switch between issues that are still open, and those that are already resolved (3). + +Some projects define milestones (4), to which issues can be assigned. They are good for +visualizing the high-level progress of a project's development. + +You can create an issue by clicking on the green "New Issue" button (5) at the top left +of the issues list. + +Issues in the issue tracker are public and everyone is able to read and answer to them. + +An Issue can have an assignee, meaning someone responsible for resolving or moderating +the issue. Their profile picture, with a link to their profile, can be seen in the issue +list. + +### Life of an Issue +Once an Issue in the Issue Tracker has been created, it will usually pass through a +process of review, discussion and closure, which is sometimes more, sometimes less +strictly defined, based on the project you're contributing to. + +The first thing that might happen is that your issue is categorized using labels. +Your issue may be reviewed by the project's maintainer(s) and evaluated whether it i.e. might be a duplicate or an invalid bug report. + +Then, depending on what kind of issue it is, there might be a additional questions +or a discussion and, if applicable, the implementation of a solution (or the rejection of +the issue). + +Finally, the issue is closed, thus vanishing from the list of open issues. +Issues might have dependencies on other issues or pull requests preventing them from being closed. + +Occasionally, issues might become stale. That's when there hasn't been any progress for +an extended period of time (usually months). You might consider reviving these, if there +is a strong interest in getting them resolved (and, preferably, if you can contribute +something to them). + +> If you encounter an abandoned project and there is no way to contact the maintainer(s), +> consider forking it, if you want to assume responsibility for it (or, rather, your fork). + +### Things to consider +#### Security bugs +If the bug you have found has security implications, **do not create +an issue right away!**. Instead try contacting the project's maintainers privately. +Many projects have a dedicated e-mail-address for reporting security bugs. If the +project in question doesn't, consider writing an email directly to the project's +maintainer or ask for the address in the issue tracker. + +> **⚠** What's important is that you **don't publicly expose security bugs before they are +> fixed *and* the fixes are deployed** because **otherwise you might put the users of that +> project at severe risk**. + +#### Existing issues +Before creating a new issue, please make sure that there isn't already an existing +issue covering i.e. the bug that you want to report or the feature that you want to +request. + +If there already is an existing issue, please consider commenting that issue instead, +if there is something more that you can contribute to it. + +You should also make sure that the issue has not already been solved by having a look +the closed issues (3) as well. + +#### Try to be precise and helpful +Project maintainers love precise information about why i.e. a bug is happening. + +Some projects may even have templates that specifically ask for information like +the operating system or database software used. + +If you can provide that information, it will be easier for the project maintainer(s) +to quickly resolve your issue. And if you want it resolved even quicker, +consider writing a Pull Request solving the issue (if possible). + +#### Be (reasonably) patient +Please remember that many project maintainers work on their free software projects +in their free time. Some maintainers may answer you within minutes, others within days. +Don't be discouraged if there isn't an immediate answer. \ No newline at end of file diff --git a/content/getting-started/what-is-codeberg.md b/content/getting-started/what-is-codeberg.md index cfefadd..7e6bceb 100644 --- a/content/getting-started/what-is-codeberg.md +++ b/content/getting-started/what-is-codeberg.md @@ -4,5 +4,26 @@ eleventyNavigation: title: What is Codeberg? parent: GettingStarted order: 10 - draft: true --- + +Codeberg is a community-driven, non-profit software development platform operated +by Codeberg e.V. and centered around Codeberg.org, a Gitea-based software forge. + +On Codeberg you can develop your own [Free Software](https://simple.wikipedia.org/wiki/Free_software) projects, contribute to other +projects, [browse](https://codeberg.org/explore) through inspiring and useful +free software, share your knowledge or build your projects a home in the web +using [Codeberg Pages](/codeberg-pages), just to name a few. + +Codeberg is not a corporation but a community of free software enthusiasts providing +a humane, non-commercial and privacy-friendly alternative to commercial services +such as GitHub. + +Codeberg e.V. is a registered association based in Berlin, Germany. You don't have to be +a member of the association in order to join Codeberg.org or to contribute to the development +of the platform, but if you want you can [join Codeberg e.V.](https://join.codeberg.org) to +support the project financially, be informed about Codeberg and, optionally, to actively +contribute to the association. + +
  + +To start your journey with Codeberg, let's [create an account](/getting-started/first-steps). \ No newline at end of file diff --git a/content/getting-started/wiki-basics.md b/content/getting-started/wiki-basics.md new file mode 100644 index 0000000..fb97ece --- /dev/null +++ b/content/getting-started/wiki-basics.md @@ -0,0 +1,8 @@ +--- +eleventyNavigation: + key: WikiBasics + title: Contributing to Wikis + parent: GettingStarted + order: 50 + draft: true +--- \ No newline at end of file diff --git a/content/home.md b/content/home.md index 9affd79..c388007 100644 --- a/content/home.md +++ b/content/home.md @@ -5,4 +5,4 @@ Welcome to the Codeberg Documentation pages! Please choose a section from the menu on the left. -If you're new to Codeberg, consider starting at [Getting Started](/getting-started). \ No newline at end of file +If you're new to Codeberg, consider reading the [Getting Started Guide](/getting-started). \ No newline at end of file