aboutsummaryrefslogtreecommitdiffstats
path: root/git.sr.ht
diff options
context:
space:
mode:
authorDrew DeVault <sir@cmpwn.com>2018-07-10 11:18:21 -0400
committerDrew DeVault <sir@cmpwn.com>2018-07-10 11:18:21 -0400
commitde673fdbad14595e3e5d1264179043011bee4f47 (patch)
tree6ec087cf24578887f2a4511a79fafd86ce954ae0 /git.sr.ht
parent8c2a53c2a2458905f65a25244b5a0fc9a3e10b8f (diff)
downloadsr.ht-docs-de673fdbad14595e3e5d1264179043011bee4f47.tar.gz
Add git resources to git.sr.ht manual
Diffstat (limited to 'git.sr.ht')
-rw-r--r--git.sr.ht/index.md37
-rw-r--r--git.sr.ht/patches.md1
2 files changed, 28 insertions, 10 deletions
diff --git a/git.sr.ht/index.md b/git.sr.ht/index.md
index c26a315..c17d2ec 100644
--- a/git.sr.ht/index.md
+++ b/git.sr.ht/index.md
@@ -10,14 +10,22 @@ 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
+# New to git?
-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.
+Learning how to use git in general is out of the scope of our documentation.
+Here are some good resources:
-The information displayed on your profile page is sourced from your [meta.sr.ht
-profile](/meta.sr.ht#profile).
+- [The official Git book](https://git-scm.com/book/en/v2)
+- [Git man pages](https://git-scm.com/docs)
+
+We do have some general resources for learning how to use git the sr.ht way:
+
+- [Sending patches to sr.ht projects](patches.md)
+- [Code review with lists.sr.ht](../lists.sr.ht/code-review.md)
+
+# git.sr.ht manual
+
+The following sections document various features of git.sr.ht.
# Repository creation
@@ -35,18 +43,18 @@ 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
+## Settings
Each repository's settings may be accessed via the settings link on the
repository's detail page.
-## Info
+### 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
+### 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
@@ -54,9 +62,18 @@ 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
+### 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.
+
+## 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).
diff --git a/git.sr.ht/patches.md b/git.sr.ht/patches.md
new file mode 100644
index 0000000..d5c6456
--- /dev/null
+++ b/git.sr.ht/patches.md
@@ -0,0 +1 @@
+TODO: Write this doc