48 Commits

Author SHA1 Message Date
Marian Harbach
ebeb15460c Enabling linkattrs explicitly on doc pages having external links
Asciidoc may fail to render link attributes for external links
supposed to open in a new window correctly. This change adds
:linkattrs: to the beginning of such files to force parsing link
attributes correctly.

Bug: Issue 12068
Change-Id: If18be60de646ff78f672239dd4fa435fd4fd92ab
2019-12-13 10:59:57 +00:00
Marian Harbach
34253376e6 Make all external links in the documentation open in a new window
To make it easier to stay on track when reading documentation, I
added ",role=external,window=_blank" to all links in the
documentation directory that were not pointing at another piece of documentation.

Change-Id: I94bf254c90f8ebce067c765be0a2932b755a045a
2019-12-10 22:54:40 +01:00
Han-Wen Nienhuys
348a6030c7 Rename "slave" to "replica" in documentation and command-line
Per
https://en.wikipedia.org/wiki/Master/slave_(technology)#Terminology_concerns
the use "slave" is considered offsensive in some circles.

For compatibility reasons, the "container.slave" property is
maintained, and the --slave flag is an alias for --replica.

Change-Id: If57df22705dac9450c1cf9900f051d9123d7dd2c
2019-09-26 23:19:53 +02:00
Edwin Kempin
be304b5b85 Drop outdated documentation about i18n support
This documentation page is not very informative. Basically it says we
don't have i18n support because "there are some issues with the way the
code produces output". I'm not sure how the situation is with PolyGerrit
nowadays, but since this page hasn't been updated in a long time it's
safe to assume that the information in it is mostly outdated and hence
having this page doesn't provide much value.

We still dicuss "Internationalization and Localization" in the dev
design.

Signed-off-by: Edwin Kempin <ekempin@google.com>
Change-Id: Ia0c21b06acf43bd8098ec52dd1c9b3580206d4b6
2019-04-24 09:06:50 +09:00
Edwin Kempin
20d1039985 Move 'Project Information' up to the community index page
We plan to add more information to the 'Project Information' section,
e.g. roadmap, release plan and backlog.

Signed-off-by: Edwin Kempin <ekempin@google.com>
Change-Id: Ic44355269f860e331302eedb3483f80bf899bac5
2019-04-24 09:06:50 +09:00
Edwin Kempin
55e975b1c8 dev-design.txt: Fix link to release versions
The old page no longer exists.

Signed-off-by: Edwin Kempin <ekempin@google.com>
Change-Id: I373f9d8d417236b6af433635afe8de85ff99a8e8
2019-04-24 09:06:50 +09:00
Edwin Kempin
e0b79b62d5 dev-design.txt: Fix link to change review
Link to the open changes of the 'gerrit' project on
gerrit-review.googlesource.com. This is the same link that is used on
the homepage.

Signed-off-by: Edwin Kempin <ekempin@google.com>
Change-Id: I2e01a1b8f537f033b15b7afe0b4ce700d09e4230
2019-04-24 09:06:50 +09:00
Edwin Kempin
3579ac0c97 Drop 'Caveats' section from dev design
This section reads like some ancient justification for having Gerrit. It
may make sense to have this kind of information, but then we should also
mention GitHub and GitLab as alternatives to Gerrit. Just drop this
section for now.

Signed-off-by: Edwin Kempin <ekempin@google.com>
Change-Id: Ie53abc6c8e453571ec84047c3af504a82ef5d70b
2019-04-24 09:06:44 +09:00
Edwin Kempin
885ed545d7 Drop 'Testing Plan' section from dev design
Gerrit does have automated tests since a long time. We should probably
have some dedicated documentation about how the Gerrit tests work so
that contributors can learn how to write tests, but this information
should not be part of the dev design. Hence just drop this useless
section for now.

Signed-off-by: Edwin Kempin <ekempin@google.com>
Change-Id: I03e2c09c3b509b2d2cf212700845b9c6e6eb044e
2019-04-23 15:42:44 +02:00
David Pursehouse
d008575bf9 dev-design: Remove section about JSON-RPC
This section is no longer relevant after the removal of GWT
and removal of RPC services.

Change-Id: I43ed3e8419b51c40488bab34b598cceb63e26c16
2018-12-21 00:43:19 +09:00
Edwin Kempin
4372f73031 dev-design.txt: NoteDb updates
ReviewDb is gone.

Change-Id: I4cd6038f122d739c4d200cc419a9a85011dbe6ee
Signed-off-by: Edwin Kempin <ekempin@google.com>
2018-12-11 10:35:23 +01:00
David Ostrovsky
7163dacf80 Remove GWT UI
This change also discontinues this Maven artifact:

  <groupId>com.google.gerrit</groupId>
  <artifactId>gerrit-plugin-gwtui</artifactId>

Bug: Issue 6908
Change-Id: I767118ba4a70f288b8f56686ab90aefa059912bb
2018-11-13 15:06:26 -08:00
David Pursehouse
7845019dbf Replace links to code.google.com/p/gerrit
Google Code was shut down nearly 2 years ago [1] and the links
don't work any more. Replace them with the new locations.

[1] https://opensource.googleblog.com/2015/03/farewell-to-google-code.html

Change-Id: I53e791d04eb243483d69254a296c30e59a7de479
2018-02-02 10:13:45 +09:00
David Pursehouse
ff8982d548 Update issue tracker URL in documentation
Change-Id: Ica83202a23678ea3fb93dfcff1f40fbc83c42d66
2016-06-23 06:48:12 +00:00
Shawn Pearce
792b2c4e59 Update out of date hyperlinks
Change-Id: Ie800b970cd3bf5824ff7504372f79896179e4134
2015-06-17 22:38:13 +00:00
Shawn Pearce
6d7ebc6318 Offer downloads through https://www.gerritcodereview.com/download/
Change-Id: Ibd0aa9a14f533771986cc1d43a712716457d424c
2015-06-12 19:07:37 -07:00
Yuxuan 'fishy' Wang
61698b14e0 Use the new section title style in Asciidoctor.
We previous use the section title style like:

Section level 1
===============

Section level 2
---------------

Which have a problem in Asciidoctor that the number of "="s or "-"s must match
the number of characters in the header exactly, as a result it's easy to make
mistakes while changing the titles. Asciidoctor provides a better style like:

= Section level 1

== Section level 2

So we switched to this style.

Also fixed a bug in replace_macros.py, which will not cause any problem in the
old style.

Change-Id: I811dd7238735d98f662767c17086152cd69aea02
2013-12-20 12:55:51 -08:00
David Pursehouse
659860fd94 Fix various spelling mistakes in the documentation
Change-Id: I762abb5bd34765c22b41f99c51dc37adc00766b1
2013-12-16 14:50:04 +09:00
David Pursehouse
7c1408a39f Merge branch 'stable-2.8'
* stable-2.8:
  Update the 2.8 release notes with recently merged changes
  Update documentation of the `review` command
  Fixed several spelling mistakes
  Remove deprecated approve SSH alias

Conflicts:
	Documentation/cmd-index.txt

Change-Id: Ieb4708793b0e323dcb2a68a31e59035519ec4af9
2013-11-28 17:09:03 +09:00
Matt Baker
a752b326f7 Fixed several spelling mistakes
Change-Id: I82c0819b8ea7d58120929efefba42b135a79f42e
2013-11-28 12:25:16 +09:00
Yuxuan 'fishy' Wang
99cb68dec4 Added searchbox to documentation.
This provides the entry point of the documentation search feature.

Change-Id: Iea2b707995c0e042829db509927384dcec7aaf43
2013-11-05 12:49:43 -08:00
David Pursehouse
92463561dd Fix spelling mistakes in the documentation
Change-Id: If74b7b502459573eebf764bdc89f8a01b0d65cce
2013-06-24 10:16:28 +09:00
David Pursehouse
3be717b274 Change "a SQL" to "an SQL"
Change-Id: I7521bd44e689a294433488db4a4ba4c9f310d20f
2013-05-13 16:50:33 +09:00
Bruce Zu
6b0fd7650f Update document to add content of file comment.
Change-Id: I9366263033b1865cdede75c95b08c78dcb8c44fe
2012-11-17 12:43:57 +08:00
David Pursehouse
221d4f6250 Documentation: Various corrections
Correct typos, spelling mistakes, and grammatical errors.

Change-Id: I80ec66de7b2228f9ff45a2f06faf576707195758
2012-06-12 14:54:54 +02:00
Shawn O. Pearce
7d2cb04d07 Move replication logic to replication plugin
This splits all of the replication code out of the core server
and moves it into a standard plugin. A new listener API is used
inside of the core server to notify interested plugins of any Git
reference changes, which the replication code can hook into to
schedule its events.

Change-Id: I77ee4440a009c2ce1c62fb6a445c7e3c912245f9
2012-05-18 10:25:19 -07:00
Chad Horohoe
e9855b8f68 Also mention that MySQL can support replication, not just Postgres
While I'm here, be consistent on the capitalization of MySQL in
the design document

Change-Id: I11e880e67c2e16daa72333b41d70f4518aa4394c
2012-05-06 22:28:45 -04:00
Colby Ranger
bbc9de5ac8 Fixed broken link to source in docs
Updated the documentation source code links to point to:
http://code.google.com/p/gerrit/source/checkout

instead of the not found:
http://code.google.com/p/gerrit/wiki/Source?tm=4

Change-Id: I836f718f364135b94cdf1984761bc99ec1697952
2012-04-26 09:03:20 -07:00
Shawn Pearce
fc6c07bbfc Merge "Some updates to the design docs" 2011-10-27 20:16:59 -07:00
Shawn Pearce
a4681783d5 Merge "documentation: update links from kernel.org to code.google.com" 2011-10-27 11:49:07 -07:00
Augie Fackler
ec2bb9ecdd documentation: update links from kernel.org to code.google.com
Change-Id: Ie2448e778b10eaf0d35053f373c4fcb2571d3b00
2011-10-27 13:47:06 -05:00
Edwin Kempin
f1acbb8330 Fix spelling mistakes in Gerrit documentation
Change-Id: Ieebe909a708fab4408128994aa19d3e028b299b4
Signed-off-by: Edwin Kempin <edwin.kempin@sap.com>
2011-10-27 02:24:06 +02:00
Martin Fick
b026ca3fff Some updates to the design docs
Change-Id: If683abf26fd90812aca2c6303b60ca57b19751be
2011-08-03 14:55:30 -06:00
Shawn O. Pearce
0825581d88 documentation: Update system scaling data
Change-Id: I7ac6bb8e5330d99a2e946c195930b1d3453167cd
Signed-off-by: Shawn O. Pearce <sop@google.com>
2011-04-12 00:17:12 -04:00
Karsten Dambekalns
a7f72a20d7 Adjust documentation source to current asciidoc version
This meant fixing old tables syntax, adjusting some overly long header
underlines and some other small issues.

Change-Id: I2701a5040d225454225034ed5ef7861580743707
2011-03-25 14:51:10 +01:00
Shawn O. Pearce
58b898cff4 documentation: Correct other calculations of QPS
Like my earlier mistake on the same section of this file, I forgot
to divide by 60 to go from hours to minutes.

Change-Id: I3962a508abe4024fd52b610043b99a20a5efb427
Signed-off-by: Shawn O. Pearce <sop@google.com>
2009-12-22 17:59:36 -08:00
Shawn O. Pearce
57c4ba8e81 documentation: Correct calculation of QPS
QPS is queries-per-second, but I had computed it as
queries-per-minute as I failed to account for 60 minutes
in an hour.

Change-Id: I706c81d3d7fd6677aaf4727c064d5aedf7230aa5
Signed-off-by: Shawn O. Pearce <sop@google.com>
2009-12-22 08:10:50 -08:00
Shawn O. Pearce
e31d02c9cd documentation: Clean up references to 'Gerrit2'
Now that the 2.x code base is over a year old, and has been in
production for almost a full year, its time to stop calling this
'Gerrit2' and start referring to it by the complete project name,
Gerrit Code Review.

Change-Id: Ifb37dd63b94ed7e1b938511aa0fc2a6ad3c981d6
Signed-off-by: Shawn O. Pearce <sop@google.com>
2009-12-11 17:43:39 -08:00
Shawn O. Pearce
aa5b83b04f documentation: Correct links in dev-design
The hyperlink for our issue tracker was pointing at the old wiki
page, not the Google Code issue tracker itself.  Fixed.

The hyperlink to our Gerrit installation didn't use SSL, but we
really prefer SSL.  Save users a round-trip by pointing at the SSL
port directly.

Change-Id: If7d6701df7484769753ee4229435d197432411b5
Signed-off-by: Shawn O. Pearce <sop@google.com>
2009-12-02 08:11:34 -08:00
Shawn O. Pearce
c5fed82732 Update documentation to point to etc subdirectory
These files were moved under $site_path/etc and our documentation
was out of date with that change.

Change-Id: I50f6115706c68ada871f244b21f5d5b369646f60
Signed-off-by: Shawn O. Pearce <sop@google.com>
2009-11-17 16:10:10 -08:00
Shawn O. Pearce
d6078469a9 style fixup: remote trailing whitespace from our source lines
Since Eclipse is now configured to strip trailing whitespace from a
line when saving a source file, we fix up any older source file that
still has trailing whitespace on the end of a line.

Change-Id: Ifa03d4b69f28536c6773702eb79b49fb16844ed1
Signed-off-by: Shawn O. Pearce <sop@google.com>
2009-11-02 10:37:01 -08:00
Shawn O. Pearce
e2bd1b1e9e Remove notes about HTML 5 offline support
As it stands now, we are probably never going to implement an
offline client using Google Gears or HTML 5.  Instead we are more
likely to make our database distributed, and offer offline support
by letting users just clone the Gerrit database onto their laptops.
This most likely rules out being able to do code reviews on an
Android powered phone, but its also already very hard to properly
mark a change "Verified" with such a device because one cannot do
a full compile of the project on such limited capability devices.

Signed-off-by: Shawn O. Pearce <sop@google.com>
2009-08-20 11:08:32 -07:00
Shawn O. Pearce
5500e69075 Put a link back to the index in every page footer
Signed-off-by: Shawn O. Pearce <sop@google.com>
2009-05-28 15:55:01 -07:00
Shawn O. Pearce
1261bef926 Cleanup formatting references for file system path variables
We now more consistently format these in italics.

Signed-off-by: Shawn O. Pearce <sop@google.com>
2009-05-08 18:32:12 -07:00
Shawn O. Pearce
aa8b3d4e2d Mention the contact information encryption in our design document
As of Gerrit 2.0.4 we encrypt the contact information for a user
account, limiting the amount of data we capture and store.  This
is an important to mention when describing how we manage private
user information.

Signed-off-by: Shawn O. Pearce <sop@google.com>
2009-03-01 11:10:55 -08:00
Shawn O. Pearce
142385def7 Mention the OpenID provider restriction feature in our design document
This is an important feature in our security design, as it helps to
reduce the attack surface available due to the use of OpenID.

Signed-off-by: Shawn O. Pearce <sop@google.com>
2009-03-01 11:09:05 -08:00
Shawn O. Pearce
4a7f6fa444 Add how/why we call Gerrit Gerrit to the background section
Its an unusual name for software.  More often than not, a person
is named "Gerrit".  We should explain that is in fact where the
name came from, and what Gerrit2 is about.

Signed-off-by: Shawn O. Pearce <sop@google.com>
2009-02-17 17:26:13 -08:00
Shawn O. Pearce
c4bcc0986d Add a document describing Gerrit's high level design
Signed-off-by: Shawn O. Pearce <sop@google.com>
2009-02-08 17:00:20 -08:00