Restructure installation docs #503
Conversation
- Split installation docs into one page per OS - Create installation overview page - Make Getting Started a top level menu - Add new pages to sidebar - Edit AAD Windows instructions - Move SELinux section to FAQ Fixes appsody#375
|
@SueChaplain and @neeraj-laad - following an informal review with Sue & Esther this morning I've pushed up another set of changes to the Overview page. The only thing stopping this PR being merged (if the rewording can be agreed of course!!!) is that the Testing doc link in the Overview points to a nonexistent doc at the current time. It would be good to get this merged this week if possible, the Testing link can always be edited out and added in under a separate PR. |
neeraj-laad
added
documentation
| - Red Hat Enterprise Linux (RHEL) | ||
| - Windows® - Windows 10 Professional and Windows 10 Enterprise editions only | ||
|
|
||
| To find out more details about the operating system versions that Appsody tests against, refer to [Testing](). |
There was a problem hiding this comment.
Did you decide where to put the testing information yet?
There was a problem hiding this comment.
No, I've only got as far as raising an issue appsody/appsody#906. To get this PR merged as is (as this level of detail wasn't in the previous docs either) I'm going to remove this sentence and add it back in when Luke and/or I get the testing doc written.
There was a problem hiding this comment.
Removed in next commit.
|
|
||
| # Installing Appsody | ||
|
|
||
| The easiest way to install Appsody is to use the installers which are available for all supported platforms, except Windows®. |
There was a problem hiding this comment.
... installers, which ....
There was a problem hiding this comment.
Fixed in next commit.
|
|
||
| # Installing on Windows | ||
|
|
||
| > Appsody runs only on Windows 10 Professional and Windows 10 Enterprise editions. If you are running Windows 10 Enterprise with authentication through Azure Active Directory, follow the additional instructions in [Appsody and Docker Desktop on Windows 10](/docs/docker-windows-aad). |
There was a problem hiding this comment.
Still not sure about the AAD stuff being in a hidden file. I can remember us discussing a troubleshooting topic at one point, which might be a good place to put this. Maybe we already talked about that?
There was a problem hiding this comment.
We've touched on this but not settled on a definitive solution as such. I'd like to get this merged as is and then address moving the AAD stuff (as I don't want to restructure FAQ/Troubleshooting under this PR as that feels like a separate topic).
Move docker permissions into Prerequisites as per Neeraj's review.
Address Neeraj's review comments by moving docker permissions into pre-reqs.
Remove step 1 when there is only one step.
Updating requirements as per Neeraj's review comments.
|
@helenmasters - I understand why the pre-req section is changed .... am ok with it. @neeraj-laad are you going to approve so we can merge? |
Checklist
Description
Complete restructure of the installation related documentation:
Related Issues
Fixes #375 #401