@@ -6,6 +6,11 @@ so that you have a reference for how we're using them.
6
6
7
7
.. glossary ::
8
8
9
+ CI/CD
10
+ CI/CD is a common way to write *Continuous Integration and Continuous Deployment *.
11
+ In some scenarios, they exist as two separate platforms.
12
+ Read the Docs contains a combined CI/CD platform made for documentation.
13
+
9
14
dashboard
10
15
The "admin" site where Read the Docs projects are managed and configured.
11
16
This varies for our two properties:
@@ -39,6 +44,18 @@ so that you have a reference for how we're using them.
39
44
and rules for publication of documentation can be :doc: `automated </automation-rules >`.
40
45
Similar to :term: `Docs as Code `.
41
46
47
+ webhooks
48
+ A webhook is a special URL that can be called from another service,
49
+ usually with a secret token.
50
+ It is commonly used to start a build or a deployment or to send a status update.
51
+
52
+ There are two important types of webhooks for Read the Docs:
53
+
54
+ * Git providers have webhooks which are special URLs that Read the Docs can call in order to notify about documentation builds.
55
+ * Read the Docs has a unique webhook for each project that the Git provider calls when changes happen in Git.
56
+
57
+ See also: :doc: `/guides/git-integrations ` and :doc: `/build-notifications `
58
+
42
59
pre-defined build jobs
43
60
Commands executed by Read the Docs when performing the build process.
44
61
They cannot be overwritten by the user.
@@ -58,7 +75,7 @@ so that you have a reference for how we're using them.
58
75
You can also think of being *reproducible * as being *robust * or *resillient *.
59
76
60
77
The typical issue with builds that are not reproducible is that their builds break entirely,
61
- needubg frequent troubleshooting and manual fixing.
78
+ needing frequent troubleshooting and manual fixing.
62
79
63
80
See: :doc: `/guides/reproducible-builds `.
64
81
@@ -68,6 +85,21 @@ so that you have a reference for how we're using them.
68
85
and hyphens. You can retrieve your project or version slugs from
69
86
:doc: `our API <api/v3 >`.
70
87
88
+ static website
89
+ A static site or static website is a collection of HTML files, images, CSS and JavaScript that are served statically,
90
+ as opposed to dynamic websites that generate a unique response for each request, using databases and user sessions.
91
+
92
+ Static websites are highly portable, as they do not depend on the webserver.
93
+ They can also be viewed offline.
94
+
95
+ Documentation projects served on Read the Docs are *static websites *.
96
+
97
+ Tools to manage and generate static websites are commonly known as *static site generators * and there is a big overlap with documentation tools.
98
+ Some static site generators are also documentation tools,
99
+ and some documentation tools are also used to generate normal websites.
100
+
101
+ For instance, :doc: `Sphinx <sphinx:index >` is made for documentation but also used for blogging.
102
+
71
103
subproject
72
104
Project A can be configured such that when requesting a URL ``/projects/<subproject-slug> ``,
73
105
the root of project B is returned.
0 commit comments