|
| 1 | +.. contents:: On this page |
| 2 | + :local: |
| 3 | + :backlinks: none |
| 4 | + :depth: 1 |
| 5 | + :class: singlecol |
| 6 | + |
| 7 | +Tables |
| 8 | +------ |
| 9 | + |
| 10 | +.. list-table:: |
| 11 | + :header-rows: 1 |
| 12 | + :stub-columns: 1 |
| 13 | + |
| 14 | + * - Platform |
| 15 | + - 4.0 Community & Enterprise |
| 16 | + - 3.6 Community & Enterprise |
| 17 | + * - Ubuntu 16.04 |
| 18 | + - x |
| 19 | + - x |
| 20 | + |
| 21 | +Pullouts and other formatting niceties |
| 22 | +-------------------------------------- |
| 23 | + |
| 24 | +.. note:: This is a note |
| 25 | + |
| 26 | + This is a note, use this when you really just want the user to read something, but it's not an emergency if they don't. |
| 27 | + |
| 28 | +.. warning:: This is a warning |
| 29 | + |
| 30 | + Use this when you have something to say that if ignored could result in danger. |
| 31 | + |
| 32 | +.. important:: This is an important thing |
| 33 | + |
| 34 | + Something that is important to know, but not an emergency. |
| 35 | + |
| 36 | +.. tip:: This is a tip |
| 37 | + |
| 38 | + Make the reader feel like an insider |
| 39 | + |
| 40 | +Literal include with a code block |
| 41 | +--------------------------------- |
| 42 | + |
| 43 | +language options are: |
| 44 | + |
| 45 | +- javascript |
| 46 | +- java |
| 47 | +- node |
| 48 | +- python |
| 49 | +- go |
| 50 | +- csharp |
| 51 | +- c++ |
| 52 | +- sh |
| 53 | + |
| 54 | +.. literalinclude:: /driver-examples/react_stitch_google.js |
| 55 | + :language: javascript |
| 56 | + :dedent: 2 |
| 57 | + :start-after: start stitch import |
| 58 | + :end-before: end stitch import |
| 59 | + |
| 60 | +Plain code block |
| 61 | +---------------- |
| 62 | + |
| 63 | +Use this code block when you need to embed something in the page directly. Note that language formatting is specified as a parameter. |
| 64 | + |
| 65 | +.. code-block:: sh |
| 66 | + |
| 67 | + npm install mongodb-stitch-browser-sdk |
| 68 | +
|
| 69 | +Including images |
| 70 | +---------------- |
| 71 | + |
| 72 | +Indicate alt text and screen size. |
| 73 | + |
| 74 | +Include a figure: |
| 75 | + |
| 76 | +.. figure:: /images/compass-find-filter-and-or.png |
| 77 | + :alt: Always use alt so screen readers can see. |
| 78 | + :figwidth: 300px |
| 79 | + |
| 80 | + |
| 81 | +The Uriwriter |
| 82 | +------------- |
| 83 | + |
| 84 | +The uriwriter is a directive that will inject a simple form into the page for the user to copy/paste their connection string (without password of course). Alternatively they can type their server params for self-managed MongoDB instances. Once populated, any content in code blocks that contain <URISTRING> will be replaced with a connection string. |
| 85 | + |
| 86 | +.. note:: Tabs |
| 87 | + |
| 88 | + Hidden tabs for the tabs-cloud set and the languages tab set will result in toggle pills at the top of the page. The page will behave differently if you've selected cloud vs local. |
| 89 | + |
| 90 | +.. tabs-cloud:: |
| 91 | + |
| 92 | + hidden: true |
| 93 | + |
| 94 | + tabs: |
| 95 | + - id: cloud |
| 96 | + content: | |
| 97 | + |
| 98 | + Lucky cloud user! |
| 99 | + |
| 100 | + |
| 101 | + - id: local |
| 102 | + content: | |
| 103 | + |
| 104 | + .. tabs-platforms:: |
| 105 | + |
| 106 | + tabs: |
| 107 | + |
| 108 | + - id: windows |
| 109 | + content: | |
| 110 | + |
| 111 | + We feel sorry for windows users, but we help them when we can. |
| 112 | + |
| 113 | + - id: linux |
| 114 | + content: | |
| 115 | + |
| 116 | + Linux users rock. |
| 117 | + |
| 118 | + - id: macos |
| 119 | + content: | |
| 120 | + |
| 121 | + Mac users are happier on mojave. |
| 122 | + |
| 123 | + |
| 124 | +.. uriwriter:: |
| 125 | + |
| 126 | +and here is what the output will look like in a code block: |
| 127 | + |
| 128 | +.. code-block:: sh |
| 129 | +
|
| 130 | + mongo <URISTRING> |
| 131 | +
|
| 132 | +The functionality is sticky, meaning that if the user comes back to the site later their URISTRING will display. |
| 133 | + |
| 134 | + |
| 135 | +Roles |
| 136 | +----- |
| 137 | + |
| 138 | +In rst, roles are a great way to create logical linking to resources that may change (urls, specifically) and to provide standard formatting across the site. |
| 139 | + |
| 140 | +The idea is that by using a role you don't need to maintain links when they change, and formatting changes will take place without migration. |
| 141 | + |
| 142 | +Formatting roles |
| 143 | +---------------- |
| 144 | + |
| 145 | +:guilabel:`This is the guilabel role` |
| 146 | + |
| 147 | + |
| 148 | +Link roles |
| 149 | +---------- |
| 150 | +This is how you :doc:`Link to docs content </server/delete>` |
| 151 | + |
| 152 | +we support many roles in the legacy tool chain, more roles to come as we complete the snooty migration. |
| 153 | + |
| 154 | + |
| 155 | + |
| 156 | + |
| 157 | + |
| 158 | + |
| 159 | + |
| 160 | + |
| 161 | + |
| 162 | + |
| 163 | + |
| 164 | + |
| 165 | + |
| 166 | + |
| 167 | + |
| 168 | + |
| 169 | + |
| 170 | + |
| 171 | + |
| 172 | + |
| 173 | + |
| 174 | + |
| 175 | + |
| 176 | + |
| 177 | + |
| 178 | + |
0 commit comments