Clarify directory for additional storage profiles #6322
Conversation
|
With your changes, the documentation now references three terms: We should probably define each of these, at a minimum linking to their definitions in the Electron docs. But ideally we should only mention these concepts if they are really required. Can we get away with just mentioning |
| @@ -150,7 +150,7 @@ Once you have the additional numbers, you can setup additional storage profiles | |||
| between them using the `NODE_APP_INSTANCE` environment variable. | |||
|
|
|||
| For example, to create an 'alice' profile, put a file called `local-alice.json` in the | |||
| `config` directory: | |||
| `config` directory, a child of the Signal directory, not `appData` from above: | |||
|
|
|||
There was a problem hiding this comment.
In my experience, the appData directory is the same as the config directory listed here. Have you seen differently? Maybe we could let go of that config term?
There was a problem hiding this comment.
On macOS, we have "~/Library/Application Support/Signal-development" for appData, whereas config corresponds to something like "/Volumes/development/Signal-Desktop/config." So the location for the JSON files ends up being different from appData. Therefore, removing the config term as a directory name wouldn't show the difference on macOS.
I had the problem thinking config was in "Application Support" when it appeared in the Signal directory instead. If the documentation changes don't work for all platforms, we can discuss how to make them more inclusive.
There was a problem hiding this comment.
Ah, you are right - I'm mistaken. Maybe it's best to call that something like 'the /config subdirectory of your project checkout?' We could potentially clarify that it should go alongside all the other .json config files there?
There was a problem hiding this comment.
All good, what you suggest helps clarify the location for where to put the .json config files.
|
Thanks for your work on this. We've merged it in our internal branches, and it will be in 6.23.x. |
First time contributor checklist:
Contributor checklist:
mainbranchyarn readyrun passes successfully (more about tests here)Description
The existing instructions help us to create multiple additional storage profiles with
NODE_APP_INSTANCE.However, it was not immediately clear where to find theconfigdirectory, as there is a config.json inuserData,and for Linux the data directory is in.config.Therefore, some minor adjustments can clarify potential points of confusion.