docs/community-edition-callout-message

[HussainAther]

What?

This PR addresses #265.

I have added a clear callout message in the relevant documentation sections to explain that certain commands must be run from the community-edition folder in a Hubs CE installation.

Why?

The current documentation correctly assumes the the working directory in several places, but this does not clearly state it. So this can cause users to run commands from the wrong folder, leading to commands failing or not applying correctly.

This update makes that requirement explicit and easier to notice.

Limitations

This change that is made now focuses on clarifying the working directory requirement in the affected documentation sections. It does not reorganize the broader update or setup documentation.

Alternatives considered

Embedding the note inline in every command step was considered at one point, but a consistent callout was chosen because it is more visible and avoids repetitive wording. Concise is nice.

Open questions

None.

Additional details or related context

This is a documentation-only change that si intended to reduce a common source of user confusion when someone is updating updating or maintaining a Hubs Community Edition installation.

[Exairnous]

Thank you for the PR.

This mixes in changes from other PRs, so the commits not relevant to this PR should be dropped/removed (it looks like only the last one is meant for this PR).

As to the change itself, I think it should be at the beginning of the ## **Updating Hubs** section, not the ### How to update your Hubs CE deployment scripts (Git Version). I also think it should make some reference as to how to change directories in the terminal (although I'm not entirely sure of the best way to convey this).

[HussainAther]

ty, imaginer.

I have now cleaned up the PR so it only only contains the relevant working-directory clarification.

• note moved to the the beginning of the Updating Hubs section

• added a brief instruction about changing into the community-edition directory first.

[Exairnous]

Thank you for the update Syed, it will be reviewed.

[hobbs-Hobbler]

Thank you @HussainAther . At the Documentation Session on Wednesday, the concern was raised that we've been instructing users to get to/change to the community-edition folder by using 'cd community-edition' (Line 130 in your PR).

Up to now, that's probably been adequate b/c the instructions had the Hubs instance owner not far away in the File Explorer structure in VS Code anyway. But an instance owner could be in a very different place, especially if they are merely getting along doing certificate renewals and perhaps the occasional restart. Thus simply 'cd community-edition' will not work in all circumstances.

Also, given that Hubs has been suffering from at least 5 changes incurred about outside software changes that have left us scrambling to update things here, we're beginning to think of our instructions in terms of future-proofing. We want them to work no matter what.

@Exairnous hypothesized one set of instructions that will work 'no matter what', directing users to use

1. Right-click on the community edition folder in a File Explorer window.
2. Select 'Copy as path'
3. In the VS Code Terminal window, type cd and paste the result. Hit enter.

I also suggested that we might create a separate, new and larger FAQ item on how to get to the community-edition folder, that could have this reasoning (these instructions should always work) and helpful screen captures.

What does this mean for this PR?
We probably want to change line 130 to a link to the new FAQ, which isn't made yet.

But we don't have time right now to make the new FAQ as we're deep in our Mozilla Branding Removal sprint, so this PR might have to go onto our backlog to wait. But once we get to it, the FAQ change and resulting link shouldn't take long.

[HussainAther]

Thank you, I think that this makes sense.

I would agreed that cd community-edition is not robust enough in all cases. Linking to a more complete, future-proof set of instructions via an FAQ sounds like the right approach.

I'm very happy to update this PR to reference that once the FAQ is in place, or to help draft the FAQ if that’s useful.