chore: update documentation for S3 / DynamoDb log store configuration #2041
Conversation
dispanser
requested review from
MrPowers,
wjones127,
fvaleye,
roeap and
ion-elgreco
as code owners
github-actions
bot
added
binding/python
|
Test failure looks unrelated, we're seeing that on main too 😦 |
dispanser
force-pushed
the
lock-client-documentation-updates
branch
from
95107f9 to
ba7484f
Compare
| so that it can be automatically recognized by delta-rs. Alternatively, you can | ||
| use a table name of your choice, but you must set the **DYNAMO_LOCK_TABLE_NAME** | ||
| use a table name of your choice, but you must set the **DELTA_DYNAMO_TABLE_NAME** |
There was a problem hiding this comment.
I don't recall from the pull request reviews previously, but why did this name change @dispanser ?
There was a problem hiding this comment.
In the initial implementation path, both locking solutions where applied at the same time, so the table name had to be different (due to incompatible schemas). After throwing out the old locking logic, I simply did not think about changing this.
Given that a user switching to the new library has to tear down the old lock table and set up the new one anyways, it may not be breaking any more than the logic change already does, and I do think having DELTA in there is actually better.
I now realize that it's not very fortunate, but with the release already made (?), changing back might make more harm than good.
|
@dispanser I can buy that argument, are there other environment variable names which might be helpful to rename to help users recognize the necessary transition? |
|
@dispanser @rtyler it seems the wrong docs were updated.. I was trying to see where they were but I noticed the previous sphinx docs were edited instead of the new mkdocs markdowns, I will bring it back in to mkdcs and also remove these old docs so it can't happen again :) |
|
Aw, I'm so sorry about that. I basically searched our code base for the relevant pieces (mostly env var names for the configuration). I should have asked. |
|
@dispanser no worries! :) It's confusing there are two docs in there still |
Description
My attempt at rewording the documentation to address the changes related to
S3DynamoDbLogStoreand its configuration.Not sure how our documentation works in the first place, and I'm not a word smith either, but at least I hope this makes things factually correct.