Description of the issue
In the "Updating Hubs" section, it is not super clear that Hubs instance owners need to be in the community-edition folder in VS Code (or whatever command prompt system) in order for the specified command prompts to run. Also, this direction -- to be in the community-edition folder-- should be more robust in all other places in our docs even if we already direct it. As an example of what we currently do, see the Beginner's Guide, step 12, h. This location does NOT use a callout box, probably because this substep, h, is in the middle of Step 12 and we've assumed a user will simply continue along, unstopped and we've brought them to the community-edition folder earlier in the same instructions).
Location of the issue
So far, I've found 7 specific locations in the Setting Up Your Hub section:
In the Updating Hubs section of the What's next document:
- How to update your Hubs CE instance
- How to update your Hubs CE deployment scripts (Git Version)
- After updating your Hubs CE deployment scripts
In Updating the Beginner's Guide:
- 12. Generate your config file step h
In How to back up your Hubs instance:
- How to do a backup
- How to restore a backup
In Regenerating SSL Certificates:
- How do I regenerate my certificates?, step 1 and step 6
Expected result from remediation
A robust reminder for Hubs instance users that they must be in the community-edition folder in order for these command prompts to run.
Screenshots of the issue
Example from the What's Next document:
Hardware the issue was observed on
Device: Desktop
OS: Windows
Browser: Firefox
Additional context/notes
A. Perhaps add a purple (HEX 8256d0) callout box? Per our Website Style Guide, purple is our "important" color. Upon looking at our current docs, we only have the yellow callout box type utilized with this code, so I am unsure if purple would look good OR be feasible. Might be something we need to test and consider:
Yellow callout box example : beginners-guide-to-CE.md, line 540:
💡 Tip: Make sure you are using your Scaleway Username and Secret Key, not your Access Key ID.
B. I believe that this section, How to update your Hubs CE deployment scripts (Zip Version) can be skipped for this issue since being in the community-edition folder is not relevant in order for the instructions to work, correct?
C. 7 places to fix = 7 expected PRs?
Description of the issue
In the "Updating Hubs" section, it is not super clear that Hubs instance owners need to be in the community-edition folder in VS Code (or whatever command prompt system) in order for the specified command prompts to run. Also, this direction -- to be in the community-edition folder-- should be more robust in all other places in our docs even if we already direct it. As an example of what we currently do, see the Beginner's Guide, step 12, h. This location does NOT use a callout box, probably because this substep, h, is in the middle of Step 12 and we've assumed a user will simply continue along, unstopped and we've brought them to the community-edition folder earlier in the same instructions).
Location of the issue
So far, I've found 7 specific locations in the Setting Up Your Hub section:
In the Updating Hubs section of the What's next document:
In Updating the Beginner's Guide:
In How to back up your Hubs instance:
In Regenerating SSL Certificates:
Expected result from remediation
A robust reminder for Hubs instance users that they must be in the community-edition folder in order for these command prompts to run.
Screenshots of the issue
Example from the What's Next document:
Hardware the issue was observed on
Additional context/notes
A. Perhaps add a purple (HEX 8256d0) callout box? Per our Website Style Guide, purple is our "important" color. Upon looking at our current docs, we only have the yellow callout box type utilized with this code, so I am unsure if purple would look good OR be feasible. Might be something we need to test and consider:
Yellow callout box example : beginners-guide-to-CE.md, line 540:
B. I believe that this section, How to update your Hubs CE deployment scripts (Zip Version) can be skipped for this issue since being in the community-edition folder is not relevant in order for the instructions to work, correct?
C. 7 places to fix = 7 expected PRs?