mirror of
https://codeberg.org/Codeberg/Documentation.git
synced 2026-08-15 14:53:29 -07:00
Just some minor tweaks to spelling, phrasing etc. (#753)
Co-authored-by: Robert Wolff <mahlzahn@posteo.de> Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/753 Reviewed-by: Robert Wolff <mahlzahn@posteo.de>
This commit is contained in:
Iridium13
Robert Wolff
parent
b061608a89
commit
246a9e43de
1 changed files with 25 additions and 26 deletions
|
|
@ -33,19 +33,19 @@ This will lead you to this page below.
|
|||
|
||||
Here's an explanation of the form's fields:
|
||||
|
||||
- **Owner** Here, you can specify whether you want this to be your own personal project or whether you want it to be part
|
||||
of an organization that you're a part of
|
||||
- **Repository name** A name for your repository (which will also be part of its path, in this case `https://codeberg.org/knut/foobar`)
|
||||
- **Owner** Here, you can specify whether you want this to be your own personal project or
|
||||
belong to an organization that you are part of.
|
||||
- **Repository name** A name for your repository (which will also be part of its path, in this case `https://codeberg.org/knut/foobar`).
|
||||
- **Visibility** Repositories are either _public_ or _private_, where public means that everyone will be able to access
|
||||
your repository, while your private repositories can only be accessed by you and your collaborators (see [Invite Collaborators](/collaborating/invite-collaborators))
|
||||
- **Description** A short description that appears next to your repository's name where appropriate
|
||||
your repository, while your private repositories can only be accessed by you and your collaborators (see [Invite Collaborators](/collaborating/invite-collaborators)).
|
||||
- **Description** A short description that appears next to your repository's name where appropriate.
|
||||
- **Template** Occasionally you may want to generate your repository from an existing template.
|
||||
In that case, you can specify that template here. Otherwise, simply leave this field empty.
|
||||
- **Issue Labels** If you want to initialize your project's issue tracker with a set of labels that you can use to
|
||||
categorize issues, you can choose one here.
|
||||
You don't have to choose this right away though, as you can choose and modify issue labels at a later time as well.
|
||||
- **.gitignore** A [.gitignore](https://git-scm.com/docs/gitignore) file defines which files Git should not keep track of.
|
||||
This is useful, for example to prevent configuration files or binaries to be tracked in version control.
|
||||
This is useful, for example to prevent configuration files or binaries from being tracked in version control.
|
||||
You can choose to add a pre-defined file matching the programming language you use now, or add one manually later.
|
||||
- **License** Here, you can choose from a list of FSF/OSI approved licenses. A `LICENSE` file will then be added to the
|
||||
repository. For some help on choosing the correct license, have a look at our [licensing article](/getting-started/licensing).
|
||||
|
|
@ -59,23 +59,23 @@ Here's an explanation of the form's fields:
|
|||
|
||||
{% admonition "warning" %}
|
||||
|
||||
If you have code locally you wish to add do **NOT** allow Codeberg to add any files to the repository.
|
||||
To prevent this, ensure the option
|
||||
If you have code locally you wish to add, do not allow Codeberg to add any files to the repository,
|
||||
by making sure that the option
|
||||
|
||||
[]-Initialize repository (Adds .gitignore, LICENSE and README)
|
||||
⬜ Initialize repository (Adds .gitignore, LICENSE and README)
|
||||
|
||||
is **not** checked.
|
||||
If Codeberg creates files, you will end up with two repositories without any shared history and Codeberg will refuse to
|
||||
sync them until you resolve the 'conflicts' manually.
|
||||
If Codeberg creates any files, you will end up with two repositories without any shared history and Codeberg will refuse to
|
||||
synchronize them until you resolve the 'conflicts' manually.
|
||||
Instead, see Option B below.
|
||||
|
||||
{% endadmonition %}
|
||||
|
||||
It's okay to only specify owner and repository name, if you want to get started quickly.
|
||||
It is okay to only specify owner and repository name, if you want to get started quickly.
|
||||
After filling out the fields, click the green "Create Repository" button on the bottom of the page.
|
||||
|
||||
You should now see a screen similar to the one below. If you haven't chosen to generate `LICENSE`, `README` and `.gitignore`
|
||||
the screen might show instructions instead, which will vanish after [your first commit](#making-a-commit).
|
||||
You should now see a screen similar to the one below, **if** you have chosen to generate `LICENSE`, `README` and `.gitignore`.
|
||||
**Otherwise**, instructions are shown how to create [your first commit](#making-a-commit) to the repository.
|
||||
|
||||
<img src="/images/getting-started/first-repository/create-repo-3.png" alt="Repository Main View">
|
||||
|
||||
|
|
@ -164,7 +164,7 @@ LICENSE README.md
|
|||
|
||||
### Option B: Connect an existing local source tree
|
||||
|
||||
If you already have written source code that you now would like to upload to Codeberg, follow these steps:
|
||||
If you have already written source code that you would like to upload to Codeberg now, follow these steps:
|
||||
|
||||
#### 1. Initialize a Git Repository
|
||||
|
||||
|
|
@ -216,8 +216,7 @@ knut@iceberg:~/my-project$ git remote add origin https://codeberg.org/knut/fooba
|
|||
|
||||
{% admonition "info" %}
|
||||
|
||||
When you clone a repository from the Internet, the URL that you got your copy of the repository from will be
|
||||
automatically used for the `origin` remote.
|
||||
When you clone a repository, the URL you specify is automatically used to set the remote `origin`. (`git remote get-url --all origin`)
|
||||
|
||||
{% endadmonition %}
|
||||
|
||||
|
|
@ -232,11 +231,11 @@ Now your Codeberg repository shares a common history with your local repository,
|
|||
|
||||
#### 7. Add standard files
|
||||
|
||||
Codeberg does not provide an interface to add licence files, `.gitignore` or `README.md` retrospectively,
|
||||
so you should add at least the licence and `README.md` yourself.
|
||||
Codeberg does not provide an interface to add license files, `.gitignore` or `README.md` retrospectively,
|
||||
so you should add at least the license and `README.md` yourself.
|
||||
|
||||
- To choose a licence, read [Codeberg's guidance](https://docs.codeberg.org/getting-started/licensing/).
|
||||
- If you already know which licence you need, Codeberg has [copies](https://codeberg.org/Codeberg-Infrastructure/forgejo/src/options/license).
|
||||
- To choose a license, read [Codeberg's guidance](https://docs.codeberg.org/getting-started/licensing/).
|
||||
- If you already know which license you need, Codeberg has [copies](https://codeberg.org/Codeberg-Infrastructure/forgejo/src/options/license).
|
||||
- [gitignores](https://codeberg.org/Codeberg-Infrastructure/forgejo/src/options/gitignore)
|
||||
|
||||
## Making a commit
|
||||
|
|
@ -262,7 +261,7 @@ knut@iceberg:~/repositories/foobar$ cat README.md
|
|||
Hello World!
|
||||
```
|
||||
|
||||
Now, if you now ask Git about your repository's status, you should see something similar to this:
|
||||
Now, if you ask Git about your repository's status, you should see something similar to this:
|
||||
|
||||
```bash
|
||||
knut@iceberg:~/repositories/foobar$ git status
|
||||
|
|
@ -329,7 +328,7 @@ Date: Sat Sep 26 12:29:57 2020 +0200
|
|||
|
||||
### 4. Push your changes to Codeberg
|
||||
|
||||
If you're happy with the changes you made, the next step is to present them to the world by pushing them to Codeberg:
|
||||
If you're happy with the changes you have made, the next step is to present them to the world by pushing them to Codeberg:
|
||||
|
||||
```bash
|
||||
knut@iceberg:~/repositories/foobar$ git push -u origin main
|
||||
|
|
@ -378,14 +377,14 @@ Congratulations - you've just made your first source code contribution on Codebe
|
|||
## Promote your work
|
||||
|
||||
If you want to promote your work you can use [Codeberg's Badge Generator](https://get-it-on.codeberg.org/) to easily
|
||||
generate a badge which links to you repository.
|
||||
generate a badge which links to your repository.
|
||||
|
||||
In the badge generator you can edit how the badge should appear. Mainly this is:
|
||||
|
||||
- **Claim**: What should be written on the badge above the Codeberg logo. Think of something catchy.
|
||||
- **Type**: You can choose between three different themes.
|
||||
- **Background**: Change the background color of your badge to fit to your site.
|
||||
- **PNG width**: The width of your badge, the generate will automatically scale it with correct proportions.
|
||||
- **Background**: Change the background color of your badge to fit your site.
|
||||
- **PNG width**: The width of your badge, the generator will automatically scale it with correct proportions.
|
||||
|
||||
<img src="/images/getting-started/first-repository/badge-settings.jpg" alt="Settings in Codeberg's badge generator">
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue