summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSven Selberg <svense@axis.com>2023-10-31 11:48:11 +0100
committerSven Selberg <svense@axis.com>2023-10-31 12:59:22 +0000
commit8d8f08e414cff27b112f655f4b06053b491663fc (patch)
tree2bf74808878a7a731ae663d5b1e13b98fb40d32d
parent7bdee49e2412a7fd62572e7caae85748f282a8d2 (diff)
Document the Edit URL feature
Release-Notes: skip Change-Id: I8d14dde5ea938cda2aad80a81003cf51eaeacb6f
-rw-r--r--Documentation/user-inline-edit.txt19
-rw-r--r--Documentation/user-upload.txt6
2 files changed, 23 insertions, 2 deletions
diff --git a/Documentation/user-inline-edit.txt b/Documentation/user-inline-edit.txt
index e3e0f681e2..910adc1ae0 100644
--- a/Documentation/user-inline-edit.txt
+++ b/Documentation/user-inline-edit.txt
@@ -15,6 +15,9 @@ To learn more, see the link:intro-user.html[Gerrit User's Guide].
[[create-change]]
== Creating a Change
+[[create_in_web_interface]]
+=== In the web interface
+
To create a change in the Gerrit web interface:
. From the link:http://gerrit-review.googlesource.com[Gerrit Code Review,role=external,window=_blank]
@@ -64,6 +67,22 @@ change.
. Add the files you want to be reviewed.
+[[create_from_url]]
+=== From URL
+
+Gerrit supports creating a new change and opening a specific file for edit
+in that change from an "Edit URL":
+```
+^\/admin\/repos\/edit\/repo\/(.+)\/branch\/(.+)\/file\/(.+)$
+```
+This enables other tools to provide a direct link to edit their configuration
+files in Gerrit.
+
+Ex:
+```
+https://gerrit.mycompany.com/admin/repo/my/repo/branch/refs/heads/master/file/Jenkinsfile # Jenkins build file
+https://gerrit.mycompany.com/admin/repo/my/repo/branch/refs/heads/master/file/catalog-info.yaml # Backstage catalog-info
+```
[[add-files]]
== Adding a File to a Change
diff --git a/Documentation/user-upload.txt b/Documentation/user-upload.txt
index 8c51207584..c6fce2a531 100644
--- a/Documentation/user-upload.txt
+++ b/Documentation/user-upload.txt
@@ -1,13 +1,15 @@
:linkattrs:
= Gerrit Code Review - Uploading Changes
-Gerrit supports three methods of uploading changes:
+Gerrit supports five methods of uploading changes:
* Use `repo upload`, to create changes for review
* Use `git push`, to create changes for review
+* link:user-inline-edit.html#create_in_web_interface[Create a change for review from the web interface]
+* link:user-inline-edit.html#create_from_url[Create a change for review by using an "Edit URL"]
* Use `git push`, and bypass code review
-All three methods rely on authentication, which must first be configured
+All five methods rely on authentication, which must first be configured
by the uploading user.
Gerrit supports two protocols for uploading changes; SSH and HTTP/HTTPS. These