WIP Replicated concepts#4065
Conversation
✅ Deploy Preview for replicated-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for replicated-docs-upgrade ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
replicated-ci
added
type::docs
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit
vale
docs/vendor/concepts-delivery.mdx|59 col 1| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-support.mdx|5 col 1| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-support.mdx|6 col 46| [Replicated.Passive] In general, use active voice instead of passive voice ('are resolved').
docs/vendor/concepts-support.mdx|9 col 1| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-support.mdx|9 col 27| [Vale.Spelling] Did you really mean 'SLAs'?
docs/vendor/concepts-support.mdx|11 col 1| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-support.mdx|13 col 1| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-support.mdx|13 col 89| [Replicated.Acronyms] Spell out 'MTTR' on first use, if it's unfamiliar to the audience.
docs/vendor/concepts-support.mdx|16 col 17| [Replicated.PositionalLanguage] Avoid spacial and directional language like 'right'. Instead, use 'on this page', 'the following', or link to the section.
docs/vendor/concepts-support.mdx|18 col 190| [Replicated.WordsToAvoid] Avoid using the word 'simply'.
docs/vendor/concepts-support.mdx|18 col 393| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-support.mdx|18 col 427| [Replicated.Passive] In general, use active voice instead of passive voice ('be used').
docs/vendor/concepts-support.mdx|18 col 620| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-support.mdx|20 col 1| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-support.mdx|20 col 198| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-license.mdx|5 col 59| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-license.mdx|7 col 156| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-license.mdx|10 col 1| [Replicated.OxfordComma] Use the Oxford comma in 'Licensing is a cross-functional concern as it is important to many different teams that licenses are easy to create, update and'.
docs/vendor/concepts-license.mdx|10 col 1| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-license.mdx|10 col 102| [Replicated.WordsToAvoid] Avoid using the word 'easy'.
docs/vendor/concepts-license.mdx|11 col 87| [Replicated.Passive] In general, use active voice instead of passive voice ('be integrated').
docs/vendor/concepts-license.mdx|11 col 115| [Replicated.Acronyms] Spell out 'CRM' on first use, if it's unfamiliar to the audience.
docs/vendor/concepts-license.mdx|11 col 186| [Replicated.WordsToAvoid] Avoid using the word 'easily'.
docs/vendor/concepts-license.mdx|12 col 1| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-license.mdx|13 col 1| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-license.mdx|13 col 67| [Replicated.Passive] In general, use active voice instead of passive voice ('be used').
docs/vendor/concepts-license.mdx|19 col 1| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-license.mdx|20 col 11| [Vale.Spelling] Did you really mean 'expirations'?
docs/vendor/concepts-license.mdx|21 col 90| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-license.mdx|21 col 194| [Replicated.PositionalLanguage] Avoid spacial and directional language like 'under'. Instead, use 'on this page', 'the following', or link to the section.
docs/vendor/concepts-license.mdx|22 col 61| [Replicated.Passive] In general, use active voice instead of passive voice ('be run').
docs/vendor/concepts-license.mdx|23 col 55| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-license.mdx|27 col 1| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-license.mdx|27 col 429| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-license.mdx|27 col 504| [Replicated.WordsToAvoid] Avoid using the word 'easily'.
docs/vendor/concepts-report.mdx|10 col 1| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-report.mdx|10 col 66| [Vale.Spelling] Did you really mean 'firehose'?
docs/vendor/concepts-report.mdx|13 col 152| [Vale.Spelling] Did you really mean 'discoverability'?
docs/vendor/concepts-report.mdx|14 col 1| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-report.mdx|14 col 68| [Replicated.Passive] In general, use active voice instead of passive voice ('be used').
docs/vendor/concepts-report.mdx|15 col 187| [Vale.Spelling] Did you really mean 'upsell'?
docs/vendor/concepts-report.mdx|16 col 27| [Replicated.WordsToAvoid] Avoid using the word 'simple'.
docs/vendor/concepts-report.mdx|18 col 253| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-report.mdx|18 col 365| [Replicated.WordSwaps] Use 'to' instead of 'in order to'.
docs/vendor/concepts-report.mdx|19 col 1| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-report.mdx|20 col 42| [Replicated.Passive] In general, use active voice instead of passive voice ('is associated').
docs/vendor/concepts-report.mdx|22 col 1| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-report.mdx|22 col 117| [Replicated.Passive] In general, use active voice instead of passive voice ('is discovered').
docs/vendor/concepts-report.mdx|22 col 205| [Replicated.Passive] In general, use active voice instead of passive voice ('are affected').
docs/vendor/concepts-report.mdx|22 col 240| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-report.mdx|24 col 4| [Vale.Spelling] Did you really mean 'Cutom'?
docs/vendor/concepts-report.mdx|26 col 1| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-report.mdx|26 col 247| [Replicated.Passive] In general, use active voice instead of passive voice ('be collected').
docs/vendor/concepts-report.mdx|28 col 1| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-report.mdx|28 col 20| [Replicated.Passive] In general, use active voice instead of passive voice ('be used').
docs/vendor/concepts-report.mdx|30 col 102| [Vale.Spelling] Did you really mean 'upsell'?
docs/vendor/concepts-report.mdx|31 col 88| [Vale.Spelling] Did you really mean 'discoverability'?
docs/vendor/concepts-report.mdx|34 col 70| [Replicated.Passive] In general, use active voice instead of passive voice ('is sent').
docs/vendor/concepts-report.mdx|34 col 160| [Replicated.PositionalLanguage] Avoid spacial and directional language like 'above'. Instead, use 'on this page', 'the following', or link to the section.
docs/vendor/concepts-report.mdx|42 col 1| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-report.mdx|43 col 49| [Replicated.Passive] In general, use active voice instead of passive voice ('are transmitted').
docs/vendor/concepts-report.mdx|43 col 99| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-report.mdx|44 col 98| [Replicated.Passive] In general, use active voice instead of passive voice ('being sent').
docs/vendor/concepts-report.mdx|47 col 1| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-report.mdx|47 col 108| [Replicated.Passive] In general, use active voice instead of passive voice ('be assured').
docs/vendor/concepts-report.mdx|47 col 167| [Replicated.Passive] In general, use active voice instead of passive voice ('was agreed').
docs/vendor/concepts-report.mdx|49 col 175| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-report.mdx|49 col 364| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-release.mdx|3 col 1| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-release.mdx|3 col 157| [Replicated.PositionalLanguage] Avoid spacial and directional language like 'right'. Instead, use 'on this page', 'the following', or link to the section.
docs/vendor/concepts-release.mdx|3 col 180| [Replicated.PositionalLanguage] Avoid spacial and directional language like 'right'. Instead, use 'on this page', 'the following', or link to the section.
docs/vendor/concepts-release.mdx|10 col 63| [Replicated.WordsToAvoid] Avoid using the word 'easy'.
docs/vendor/concepts-release.mdx|26 col 64| [Replicated.Passive] In general, use active voice instead of passive voice ('is made').
docs/vendor/concepts-release.mdx|26 col 89| [Replicated.PositionalLanguage] Avoid spacial and directional language like 'right'. Instead, use 'on this page', 'the following', or link to the section.
docs/vendor/concepts-release.mdx|28 col 31| [Replicated.Passive] In general, use active voice instead of passive voice ('is promoted').
docs/vendor/concepts-release.mdx|29 col 1| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-release.mdx|33 col 1| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-release.mdx|35 col 1| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-release.mdx|37 col 28| [Vale.Spelling] Did you really mean 'keepseparate'?
docs/vendor/concepts-release.mdx|38 col 106| [Replicated.Passive] In general, use active voice instead of passive voice ('are subscribed').
docs/vendor/concepts-release.mdx|44 col 38| [Replicated.Passive] In general, use active voice instead of passive voice ('is designed').
docs/vendor/concepts-release.mdx|45 col 30| [Replicated.Passive] In general, use active voice instead of passive voice ('is designed').
docs/vendor/concepts-release.mdx|46 col 34| [Replicated.Passive] In general, use active voice instead of passive voice ('is designed').
docs/vendor/concepts-release.mdx|50 col 261| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-release.mdx|54 col 326| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-release.mdx|56 col 1| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-release.mdx|56 col 225| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-release.mdx|58 col 4| [Replicated.Headings] 'Provide Secure Access to Images with the proxy registry' should use sentence case.
docs/vendor/concepts-release.mdx|63 col 65| [Replicated.Passive] In general, use active voice instead of passive voice ('be used').
docs/vendor/concepts-release.mdx|64 col 1| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-release.mdx|69 col 79| [Replicated.Passive] In general, use active voice instead of passive voice ('be tracked').
docs/vendor/concepts-release.mdx|71 col 4| [Replicated.Headings] 'Release Versioning' should use sentence case.
docs/vendor/concepts-release.mdx|75 col 101| [Replicated.Passive] In general, use active voice instead of passive voice ('are indicated').
docs/vendor/concepts-release.mdx|76 col 1| [Replicated.OxfordComma] Use the Oxford comma in 'For example, with SemVer, alpha or'.
docs/vendor/concepts-release.mdx|76 col 1| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-release.mdx|76 col 50| [Replicated.Passive] In general, use active voice instead of passive voice ('are denoted').
docs/vendor/concepts-release.mdx|78 col 1| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-release.mdx|79 col 1| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-release.mdx|79 col 54| [Replicated.WordsToAvoid] Avoid using the word 'easily'.
docs/vendor/concepts-release.mdx|81 col 4| [Vale.Spelling] Did you really mean 'Automte'?
docs/vendor/concepts-release.mdx|83 col 1| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-release.mdx|84 col 1| [Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/vendor/concepts-release.mdx|84 col 35| [Vale.Spelling] Did you really mean 'Github'?
docs/vendor/concepts-release.mdx|84 col 92| [Replicated.PositionalLanguage] Avoid spacial and directional language like 'right'. Instead, use 'on this page', 'the following', or link to the section.
| These notifications alert vendors to key events: customer support bundle uploads, instances unhealthy for an extended period, or trial licenses about to expire. | ||
|
|
||
| ## Replicated Platform features | ||
| ## Replicated Preflightlatform features |
There was a problem hiding this comment.
[Replicated.Headings] 'Replicated Preflightlatform features' should use sentence case.
| These notifications alert vendors to key events: customer support bundle uploads, instances unhealthy for an extended period, or trial licenses about to expire. | ||
|
|
||
| ## Replicated Platform features | ||
| ## Replicated Preflightlatform features |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Preflightlatform'?
|
|
||
| # About the Replicated-supported installation options | ||
|
|
||
| Installing refers to the steps that enterprise customers take to securely deploy software in their environment. For modern on-prem software, the installation process varies depending on the release delivery method and the installation environment (such as internet-connected versus air-gapped, if the installation environment uses a proxy, or Kubernetes clusters versus VMs). |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
|
|
||
| Installing refers to the steps that enterprise customers take to securely deploy software in their environment. For modern on-prem software, the installation process varies depending on the release delivery method and the installation environment (such as internet-connected versus air-gapped, if the installation environment uses a proxy, or Kubernetes clusters versus VMs). | ||
|
|
||
| Ultimately, the challenge with installation is that the vendor has to be prepared to meet a spectrum of customer requirements and sophistication. This increases the complexity for vendors who need to consider each installation path in all future releases, testing, updates, support, and so on. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.Passive] In general, use active voice instead of passive voice ('be prepared').
|
|
||
| <Helm/> | ||
|
|
||
| The following diagram shows how Helm charts distributed with Replicated are installed with Helm in online (internet-connected) customer environments: |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.Passive] In general, use active voice instead of passive voice ('are installed').
|
|
||
| [View a larger version of this image](/images/enterprise-portal-overview.png) | ||
|
|
||
| As shown in the diagram above, your licensed customers can access the installation and update instructions for one or more application releases by logging in to the Enterprise Portal. The Enterprise Portal tracks the customer's installation attempts and progress, and shares those insights back to the Vendor Portal. After installing, customers can also upload support bundles in the Enterprise Portal. Support bundles uploaded to the Enterprise Portal are automatically made available to you in the Vendor Portal. |
There was a problem hiding this comment.
[Replicated.PositionalLanguage] Avoid spacial and directional language like 'above'. Instead, use 'on this page', 'the following', or link to the section.
|
|
||
| For information about using the Enterprise Portal, see [Access and Use the Enterprise Portal](enterprise-portal-use). | ||
|
|
||
| ## Preflight Checks |
There was a problem hiding this comment.
[Replicated.Headings] 'Preflight Checks' should use sentence case.
| For information about using the Enterprise Portal, see [Access and Use the Enterprise Portal](enterprise-portal-use). | ||
|
|
||
| ## Preflight Checks | ||
| In addition to thorough installation instructions, the best vendors also provide preflight checks that customers can run to validate if the resources provided meet the hardware, network, and environment requirements for the software before proceeding with installation. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
|
|
||
| ## Preflight Checks | ||
| In addition to thorough installation instructions, the best vendors also provide preflight checks that customers can run to validate if the resources provided meet the hardware, network, and environment requirements for the software before proceeding with installation. | ||
| These types of checks can help increase the success rate of installations and upgrades, reducing customer frustration and speeding up the time-to-value for the application. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
| In addition to thorough installation instructions, the best vendors also provide preflight checks that customers can run to validate if the resources provided meet the hardware, network, and environment requirements for the software before proceeding with installation. | ||
| These types of checks can help increase the success rate of installations and upgrades, reducing customer frustration and speeding up the time-to-value for the application. | ||
|
|
||
| ## GUI-Based Experience |
There was a problem hiding this comment.
[Replicated.Headings] 'GUI-Based Experience' should use sentence case.
2 participants
No description provided.