Skip to content

(DOCSP-12523): Remove raw html/custom css directives #500

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Oct 6, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions source/authentication/anonymous.txt
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,9 @@ different authentication provider. See :doc:`linking
</authentication/linking>` for more information on how to accomplish
this.

.. cssclass:: important
.. admonition:: Anonymous user expiration

:class: important

{+service-short+} may delete an Anonymous user object that is 90 days old (or
older). When an account is deleted, it is not recoverable and any
associated user data is lost. Documents created or modified by the
Expand Down
1 change: 0 additions & 1 deletion source/authentication/api-key.txt
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,6 @@ Configuration
files for the API Key authentication provider have the
following form:

.. cssclass:: wide-container
.. code-block:: none
:caption: ``/auth_providers/api-key.json``

Expand Down
10 changes: 1 addition & 9 deletions source/authentication/custom-jwt.txt
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,6 @@ Configuration
stored in the ``/auth_providers`` directory. Configuration files
for the Custom authentication provider have the following form:

.. cssclass:: wide-container
.. code-block:: none
:caption: ``/auth_providers/custom-token.json``

Expand Down Expand Up @@ -116,7 +115,6 @@ value, then you can configure the provider to use that value instead.
To override the default audience, specify a new value in the
:guilabel:`Audience` input:

.. cssclass:: bordered-figure
.. figure:: /images/custom-jwt-audience.png
:alt: The Custom JWT audience configuration input

Expand Down Expand Up @@ -176,7 +174,6 @@ JWTs.
]
}

.. cssclass:: auth-table
.. list-table::
:header-rows: 1
:widths: 15 30
Expand All @@ -194,7 +191,6 @@ JWTs.
- ``HS256``
- ``RS256``

.. cssclass:: bordered-figure
.. figure:: /images/custom-jwt-signing-algorithm.png
:alt: The Signing Algorithm configuration dropdown

Expand All @@ -207,7 +203,6 @@ JWTs.
Each signing key Secret must be a string with length between 32
and 512 characters.

.. cssclass:: bordered-figure
.. figure:: /images/custom-jwt-signing-key.png
:alt: The Signing Keys configuration inputs

Expand Down Expand Up @@ -244,7 +239,6 @@ signing algorithm and keys.
"jwkURI": "<JWK or JWKS URL>"
}

.. cssclass:: auth-table
.. list-table::
:header-rows: 1
:widths: 15 30
Expand All @@ -267,7 +261,6 @@ signing algorithm and keys.
and signing keys the JWTs should use. The JWKS may specify up to
three signing keys and must use the ``RS256`` algorithm.

.. cssclass:: bordered-figure
.. figure:: /images/custom-jwt-jwk-uri.png
:alt: The JWK URI input

Expand All @@ -292,8 +285,7 @@ whenever they log in and exposes the fields in the ``data`` object of the
To define a metadata field, click :guilabel:`Add Field` and
specify the mapping between the metadata field in the JWT and its
corresponding field name in the user object.

.. cssclass:: bordered-figure

.. figure:: /images/custom-auth-metadata-fields.png
:alt: The metadata fields configuration table

Expand Down
5 changes: 0 additions & 5 deletions source/authentication/email-password.txt
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,6 @@ Configuration
for the Email/Password authentication provider have the following
form:

.. cssclass:: wide-container
.. code-block:: none
:caption: ``/auth_providers/local-userpass.json``

Expand Down Expand Up @@ -174,7 +173,6 @@ object containing user data and confirmation tokens. The following table
describes the fields found in the object passed to the custom user
confirmation function:

.. cssclass:: auth-table
.. list-table::
:header-rows: 1
:widths: 15 30
Expand All @@ -199,7 +197,6 @@ confirmation function:
The following table describes the potential values of the ``status``
field in the object returned by the custom user confirmation function:

.. cssclass:: auth-table
.. list-table::
:header-rows: 1
:widths: 15 30
Expand Down Expand Up @@ -384,7 +381,6 @@ the custom password reset function, starting with the second parameter.
The following table describes the fields found in the object
passed to the custom password reset function as the first parameter:

.. cssclass:: auth-table
.. list-table::
:header-rows: 1
:widths: 15 30
Expand Down Expand Up @@ -414,7 +410,6 @@ passed to the custom password reset function as the first parameter:
The following table describes the potential values of the ``status``
field in the object returned by the custom password reset function:

.. cssclass:: auth-table
.. list-table::
:header-rows: 1
:widths: 15 30
Expand Down
2 changes: 0 additions & 2 deletions source/authentication/facebook.txt
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@ Configuration
files for the Facebook authentication provider have the
following form:

.. cssclass:: wide-container
.. code-block:: none
:caption: ``/auth_providers/oauth2-facebook.json``

Expand All @@ -75,7 +74,6 @@ Configuration
The Facebook authentication provider has the following configuration
options:

.. cssclass:: auth-table
.. list-table::
:header-rows: 1
:widths: 15 30
Expand Down
2 changes: 0 additions & 2 deletions source/authentication/google.txt
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,6 @@ Configuration
stored in the ``/auth_providers`` directory. Configuration files
for the Google authentication provider have the following form:

.. cssclass:: wide-container
.. code-block:: none
:caption: ``/auth_providers/oauth2-google.json``

Expand All @@ -71,7 +70,6 @@ Configuration
The Google authentication provider has the following configuration
options:

.. cssclass:: auth-table
.. list-table::
:header-rows: 1
:widths: 15 30
Expand Down
2 changes: 0 additions & 2 deletions source/authentication/providers.txt
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,6 @@ object:
- Email/Password users are always associated with the following
metadata fields:

.. cssclass:: config-table
.. list-table::
:header-rows: 1
:widths: 10 20
Expand All @@ -137,7 +136,6 @@ object:
- API Key users are always associated with the following metadata
fields:

.. cssclass:: config-table
.. list-table::
:header-rows: 1
:widths: 10 20
Expand Down
3 changes: 0 additions & 3 deletions source/billing.txt
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,6 @@ messages between users in the same group. The app has the following usage:
The following calculations approximate the cost of running this application for
one month:

.. cssclass:: config-table
.. list-table::
:header-rows: 1
:widths: 15 85
Expand Down Expand Up @@ -330,7 +329,6 @@ submit orders. The app has the following usage:
The following calculations approximate the cost of running this application for
one month:

.. cssclass:: config-table
.. list-table::
:header-rows: 1
:widths: 15 85
Expand Down Expand Up @@ -406,7 +404,6 @@ restaurants. The app has the following usage:

- Orders vary in size but are no larger than 4KB

.. cssclass:: config-table
.. list-table::
:header-rows: 1
:widths: 15 85
Expand Down
151 changes: 70 additions & 81 deletions source/deploy.txt
Original file line number Diff line number Diff line change
Expand Up @@ -52,91 +52,82 @@ particular development workflow.
- Details

* - {+ui+}
- .. admonition:: Use This Method If
:class: reference-block

- You want to use a browser-based GUI to develop and manage
your {+app+}.

.. admonition:: Deployment Pattern
:class: reference-block

*For a detailed walkthrough, see* :doc:`Deploy from the {+ui+}
</deploy/deploy-ui>`

1. Make changes in the UI that are saved in a draft state
and not visible to client apps.

2. Review all draft changes and then deploy them together
through the {+ui+}.
- **Use This Method If:**

- You want to use a browser-based GUI to develop and manage
your {+app+}.

**Deployment Pattern**

*For a detailed walkthrough, see* :doc:`Deploy from the {+ui+}
</deploy/deploy-ui>`

1. Make changes in the UI that are saved in a draft state
and not visible to client apps.

2. Review all draft changes and then deploy them together
through the {+ui+}.

* - Automatic GitHub Deployment
- .. admonition:: Use This Method If
:class: reference-block

- You want to use a code-first approach to app development.
- You want to use Git to version control your app.
- You want to automatically deploy changes when you push to
:github:`GitHub <>`.

.. admonition:: Deployment Pattern
:class: reference-block

*For a detailed walkthrough, see* :doc:`Deploy Automatically
with GitHub </deploy/deploy-automatically-with-github>`

1. Host your exported application repository on GitHub.

2. Add, remove, or modify configuration files in a local clone
of the repository to specify your updated application.

3. When you've made all the changes that you want to, commit
them and push the changes to GitHub.
- **Use This Method If:**

- You want to use a code-first approach to app development.
- You want to use Git to version control your app.
- You want to automatically deploy changes when you push to
:github:`GitHub <>`.

**Deployment Pattern**

*For a detailed walkthrough, see* :doc:`Deploy Automatically
with GitHub </deploy/deploy-automatically-with-github>`

1. Host your exported application repository on GitHub.

2. Add, remove, or modify configuration files in a local clone
of the repository to specify your updated application.

3. When you've made all the changes that you want to, commit
them and push the changes to GitHub.

* - {+cli-bin+}
- .. admonition:: Use This Method If
:class: reference-block

- You want to use a code-first approach to app development.
- You want to use a command line interface to manage and
deploy your {+app+}.

.. admonition:: Deployment Pattern
:class: reference-block

*For a detailed walkthrough, see* :doc:`Deploy Changes with
{+cli+} </deploy/deploy-cli>`

1. Export a copy of your application to a directory of
configuration files and download it to your computer.

2. Add, remove, or modify configuration files in the directory
to specify your updated application.

3. When you've made all the changes that you want to,
manually deploy them by importing the updated application
directory.
- **Use This Method If:**

- You want to use a code-first approach to app development.
- You want to use a command line interface to manage and deploy your {+app+}.

**Deployment Pattern**

*For a detailed walkthrough, see* :doc:`Deploy Changes with
{+cli+} </deploy/deploy-cli>`

1. Export a copy of your application to a directory of
configuration files and download it to your computer.

2. Add, remove, or modify configuration files in the directory
to specify your updated application.

3. When you've made all the changes that you want to,
manually deploy them by importing the updated application
directory.

* - {+service-short+} Admin API
- .. admonition:: Use This Method If
:class: reference-block

- You want to use a code-first approach to app development.
- You want to use an HTTP API to manage and deploy your {+app+}.

.. admonition:: Deployment Pattern
:class: reference-block

*For a detailed walkthrough, see* :ref:`Draft and Deploy a
Group of Changes <admin-api-draft-deploy>`

1. Create a new draft deployment through the API.

2. Add, remove, or modify components of your application by
calling relevant HTTP endpoints.

3. When you've made all the changes that you want to,
deploy the draft through the API.
- **Use This Method If:**

- You want to use a code-first approach to app development.
- You want to use an HTTP API to manage and deploy your {+app+}.

**Deployment Pattern**

*For a detailed walkthrough, see* :ref:`Draft and Deploy a
Group of Changes <admin-api-draft-deploy>`

1. Create a new draft deployment through the API.

2. Add, remove, or modify components of your application by
calling relevant HTTP endpoints.

3. When you've made all the changes that you want to,
deploy the draft through the API.

.. _app-components:

Expand Down Expand Up @@ -200,8 +191,6 @@ represents draft changes made since the previous deployment. You can use
the :guilabel:`Action` buttons on this row to manually deploy all draft
changes.


.. cssclass:: bordered-figure
.. figure:: /images/deployment-history-table.png
:alt: The table of application deployment history logs in the {+ui+}

Expand Down
1 change: 0 additions & 1 deletion source/deploy/export-realm-app.txt
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ The simplest way to export a {+app+} is directly from the
navigation, select the :guilabel:`Import/Export App` tab, and then click
the :guilabel:`Export App` button.

.. cssclass:: bordered-figure
.. figure:: /images/export-app-button.png

Export with {+cli-bin+}
Expand Down
6 changes: 2 additions & 4 deletions source/functions/utilities.txt
Original file line number Diff line number Diff line change
Expand Up @@ -529,8 +529,7 @@ cryptographic algorithms.
- String
- A private key generated with the specified encryption type.

.. admonition:: Key Format
:class: reference-block
.. important:: Key Format

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

.. admonition:: Key Format
:class: reference-block
.. important:: Key Format

Not all RSA keys use the same format. Realm can only
verify signatures with RSA keys that conform to the
Expand Down
Loading