Skip to content

Commit 642f928

Browse files
committed
(DOCSP-12523): reference-block
1 parent f5ab607 commit 642f928

File tree

2 files changed

+72
-83
lines changed

2 files changed

+72
-83
lines changed

source/deploy.txt

Lines changed: 70 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -52,91 +52,82 @@ particular development workflow.
5252
- Details
5353

5454
* - {+ui+}
55-
- .. admonition:: Use This Method If
56-
:class: reference-block
57-
58-
- You want to use a browser-based GUI to develop and manage
59-
your {+app+}.
60-
61-
.. admonition:: Deployment Pattern
62-
:class: reference-block
63-
64-
*For a detailed walkthrough, see* :doc:`Deploy from the {+ui+}
65-
</deploy/deploy-ui>`
66-
67-
1. Make changes in the UI that are saved in a draft state
68-
and not visible to client apps.
69-
70-
2. Review all draft changes and then deploy them together
71-
through the {+ui+}.
55+
- **Use This Method If:**
56+
57+
- You want to use a browser-based GUI to develop and manage
58+
your {+app+}.
59+
60+
**Deployment Pattern**
61+
62+
*For a detailed walkthrough, see* :doc:`Deploy from the {+ui+}
63+
</deploy/deploy-ui>`
64+
65+
1. Make changes in the UI that are saved in a draft state
66+
and not visible to client apps.
67+
68+
2. Review all draft changes and then deploy them together
69+
through the {+ui+}.
7270

7371
* - Automatic GitHub Deployment
74-
- .. admonition:: Use This Method If
75-
:class: reference-block
76-
77-
- You want to use a code-first approach to app development.
78-
- You want to use Git to version control your app.
79-
- You want to automatically deploy changes when you push to
80-
:github:`GitHub <>`.
81-
82-
.. admonition:: Deployment Pattern
83-
:class: reference-block
84-
85-
*For a detailed walkthrough, see* :doc:`Deploy Automatically
86-
with GitHub </deploy/deploy-automatically-with-github>`
87-
88-
1. Host your exported application repository on GitHub.
89-
90-
2. Add, remove, or modify configuration files in a local clone
91-
of the repository to specify your updated application.
92-
93-
3. When you've made all the changes that you want to, commit
94-
them and push the changes to GitHub.
72+
- **Use This Method If:**
73+
74+
- You want to use a code-first approach to app development.
75+
- You want to use Git to version control your app.
76+
- You want to automatically deploy changes when you push to
77+
:github:`GitHub <>`.
78+
79+
**Deployment Pattern**
80+
81+
*For a detailed walkthrough, see* :doc:`Deploy Automatically
82+
with GitHub </deploy/deploy-automatically-with-github>`
83+
84+
1. Host your exported application repository on GitHub.
85+
86+
2. Add, remove, or modify configuration files in a local clone
87+
of the repository to specify your updated application.
88+
89+
3. When you've made all the changes that you want to, commit
90+
them and push the changes to GitHub.
9591

9692
* - {+cli-bin+}
97-
- .. admonition:: Use This Method If
98-
:class: reference-block
99-
100-
- You want to use a code-first approach to app development.
101-
- You want to use a command line interface to manage and
102-
deploy your {+app+}.
103-
104-
.. admonition:: Deployment Pattern
105-
:class: reference-block
106-
107-
*For a detailed walkthrough, see* :doc:`Deploy Changes with
108-
{+cli+} </deploy/deploy-cli>`
109-
110-
1. Export a copy of your application to a directory of
111-
configuration files and download it to your computer.
112-
113-
2. Add, remove, or modify configuration files in the directory
114-
to specify your updated application.
115-
116-
3. When you've made all the changes that you want to,
117-
manually deploy them by importing the updated application
118-
directory.
93+
- **Use This Method If:**
94+
95+
- You want to use a code-first approach to app development.
96+
- You want to use a command line interface to manage and deploy your {+app+}.
97+
98+
**Deployment Pattern**
99+
100+
*For a detailed walkthrough, see* :doc:`Deploy Changes with
101+
{+cli+} </deploy/deploy-cli>`
102+
103+
1. Export a copy of your application to a directory of
104+
configuration files and download it to your computer.
105+
106+
2. Add, remove, or modify configuration files in the directory
107+
to specify your updated application.
108+
109+
3. When you've made all the changes that you want to,
110+
manually deploy them by importing the updated application
111+
directory.
119112

120113
* - {+service-short+} Admin API
121-
- .. admonition:: Use This Method If
122-
:class: reference-block
123-
124-
- You want to use a code-first approach to app development.
125-
- You want to use an HTTP API to manage and deploy your {+app+}.
126-
127-
.. admonition:: Deployment Pattern
128-
:class: reference-block
129-
130-
*For a detailed walkthrough, see* :ref:`Draft and Deploy a
131-
Group of Changes <admin-api-draft-deploy>`
132-
133-
1. Create a new draft deployment through the API.
134-
135-
2. Add, remove, or modify components of your application by
136-
calling relevant HTTP endpoints.
137-
138-
3. When you've made all the changes that you want to,
139-
deploy the draft through the API.
114+
- **Use This Method If:**
115+
116+
- You want to use a code-first approach to app development.
117+
- You want to use an HTTP API to manage and deploy your {+app+}.
118+
119+
**Deployment Pattern**
120+
121+
*For a detailed walkthrough, see* :ref:`Draft and Deploy a
122+
Group of Changes <admin-api-draft-deploy>`
123+
124+
1. Create a new draft deployment through the API.
125+
126+
2. Add, remove, or modify components of your application by
127+
calling relevant HTTP endpoints.
128+
129+
3. When you've made all the changes that you want to,
130+
deploy the draft through the API.
140131

141132
.. _app-components:
142133

source/functions/utilities.txt

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -529,8 +529,7 @@ cryptographic algorithms.
529529
- String
530530
- A private key generated with the specified encryption type.
531531

532-
.. admonition:: Key Format
533-
:class: reference-block
532+
.. important:: Key Format
534533

535534
Not all RSA keys use the same format. Realm can only sign
536535
messages with a private key that conforms to the standard
@@ -641,8 +640,7 @@ cryptographic algorithms.
641640
the signature is valid, this is the corresponding public key
642641
of the private key that was used to sign the message.
643642

644-
.. admonition:: Key Format
645-
:class: reference-block
643+
.. important:: Key Format
646644

647645
Not all RSA keys use the same format. Realm can only
648646
verify signatures with RSA keys that conform to the

0 commit comments

Comments
 (0)