aboutsummaryrefslogtreecommitdiffstats
path: root/git.sr.ht/index.md
diff options
context:
space:
mode:
Diffstat (limited to 'git.sr.ht/index.md')
-rw-r--r--git.sr.ht/index.md60
1 files changed, 60 insertions, 0 deletions
diff --git a/git.sr.ht/index.md b/git.sr.ht/index.md
new file mode 100644
index 0000000..21fc1f4
--- /dev/null
+++ b/git.sr.ht/index.md
@@ -0,0 +1,60 @@
+[git.sr.ht](https://git.sr.ht) is a service for hosting git repositories on
+sr.ht.
+
+**See also**:
+
+- [Installation guide](installation.md)
+
+**Important**: git.sr.ht is a work in progress. As a consequence, URLs of
+specific files, commits, branches, etc in the repository viewer are **NOT**
+guaranteed to remain consistent forever. When we finish writing our new
+repository viewer, these will change.
+
+# Profile
+
+Your public profile as available at git.sr.ht/~username. Here any public
+repositories on your account are listed and searchable, but unlisted and private
+repositories are hidden unless you're logged in.
+
+The information displayed on your profile page is sourced from your [meta.sr.ht
+profile](/meta.sr.ht#profile).
+
+# Repository creation
+
+Creating new repositories is done on the [create
+page](https://git.sr.ht/create), which you can access from any page via the
+navigation on the top right.
+
+The *name* and *description* fields are used to describe your repository to the
+public. The *visibility* field will change how your repository is shown on the
+website. Public repositories are visible on your profile, to anonymous users,
+and on third-party search engines. Unlisted repositories are visible to anyone
+who has the link, but are not shown in your profile or in search results.
+Private repositories are only visible to you and other logged-in users who you
+explicitly [grant access to](#access).
+
+# Settings
+
+Each repository's settings may be accessed via the settings link on the
+repository's detail page.
+
+## Info
+
+You can change the repository's visibility and description on this page. Click
+"Rename?" if you wish to rename your repository. Renaming your repository sets
+up a redirect from the previous name to the new.
+
+## Access
+
+The access page allows you to grant other users read or write access to your
+repository. Users with read access will be able to clone and view private
+repositories on the web, and users with write access will be able to push new
+to your repository. Users will write access will not be able to edit your
+repository's settings.
+
+## Delete
+
+You can delete your repository from this page. This operation cannot be undone.
+This does not delete any other resources that may be associated with this
+project, such as a ticket tracker on todo.sr.ht or build history on
+builds.sr.ht.