Page MenuHomePhabricator

Reflect script implementation in olm-utils and dev env setup instructions
ClosedPublic

Authored by marcin on Feb 15 2022, 1:01 PM.
Tags
None
Referenced Files
Unknown Object (File)
Thu, Nov 14, 8:02 PM
Unknown Object (File)
Thu, Nov 14, 7:51 PM
Unknown Object (File)
Thu, Nov 14, 7:36 PM
Unknown Object (File)
Oct 27 2024, 11:11 PM
Unknown Object (File)
Oct 17 2024, 7:26 PM
Unknown Object (File)
Oct 17 2024, 7:26 PM
Unknown Object (File)
Oct 17 2024, 7:26 PM
Unknown Object (File)
Oct 17 2024, 7:26 PM

Details

Summary

As we decided to store pickling key and pickled olm account instead of keys, olm_config structure and dev env set up needed to be updated.

Test Plan

No need to test those changes.

Diff Detail

Repository
rCOMM Comm
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

tomek requested changes to this revision.Feb 16 2022, 7:09 AM
tomek added inline comments.
docs/dev_environment.md
567 ↗(On Diff #9700)

This not so random - we should rather say that this an encrypted / pickled data. But I'm wondering if it still makes sense to have this file structure here. We can instead explain that the script will generate a file for us.

This revision now requires changes to proceed.Feb 16 2022, 7:09 AM

Remove olm_config.json file structure from dev env setup instructions as it is no longer needed.

This revision is now accepted and ready to land.Feb 17 2022, 4:08 AM
This revision now requires review to proceed.Feb 17 2022, 4:08 AM
ashoat added inline comments.
docs/dev_environment.md
562 ↗(On Diff #9761)

Let's say "This script" instead of "The script"

This revision is now accepted and ready to land.Feb 22 2022, 12:01 AM

The relationship between this diff, D3053, and D3209 is not made clear. Please specify the dependency graph by hitting "Edit Related Revisions" in the UI above, or by having the text "Depends on: Dsomething" in either the diff description or a diff comment

Use 'This script' instead of 'The script' for better language quality.

Please do NOT land without addressing the inline comment

docs/dev_environment.md
562 ↗(On Diff #9816)
  1. "secrets directory" is ambiguous – not clear where it is exists
  2. You're missing the word "the" in a couple places

Fix language inaccuracies.

docs/dev_environment.md
562 ↗(On Diff #9816)

I addressed those problems with changes introduced.