-
Notifications
You must be signed in to change notification settings - Fork 7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
doc: storage: move "Secure Storage" and "Settings" chapters to "Storage" #85141
doc: storage: move "Secure Storage" and "Settings" chapters to "Storage" #85141
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see why one might want to have secure storage as part of storage as you can see it as another API that allows storing assets.
Though secure storage calls into NVS/ZMS which are here, so those don't quite live at the same level. And actually secure storage can even call into settings, yet another layer, which isn't even here (it's on its own).
So I don't know.
I'm not saying the current way is the way it should be and stay, but I'm not convinced by this exact change here.
From a user's point of view - it is the "storage". BTW: Probably, the mentioned "settings" should be moved here too. |
I'd be fine having secure storage in there if settings joins too. Indeed for the user it's the storage solution. @de-nordic thoughts about having the settings documentation moved inside storage? |
Settings is not in storage because, as far as I understand, it is not a storage itself, it is more to be a DB that can utilize different ways of storing/retrieving information. |
16d4329
to
296f602
Compare
"that can utilize different ways of storing/retrieving information" - behavior of a storage ;) |
296f602
to
9f81f3b
Compare
Hi @tomi-font |
9f81f3b
to
d3649ff
Compare
Secure Storage does not fit there, this is dir for things nobody wants to admit maintaining ;) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OK, if you really want.
@@ -210,7 +210,7 @@ | |||
('reference/peripherals/uart', 'hardware/peripherals/uart'), | |||
('reference/peripherals/video', 'hardware/peripherals/video'), | |||
('reference/pm/index', 'services/pm/api/index'), | |||
('reference/settings/index', 'services/settings/index'), | |||
('reference/settings/index', 'services/storage/settings/index'), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
you actually need a new entry for services/settings/index --> services/storage/settings/index please, as this is arguably the most important case to cover for e.g folks browsing the "old" page on LTS3 docs and interested in looking at the newest version
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @kartben.
The requested entry has been added.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about having an entry for secure_storage
as well? Would it make sense?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
oh yes, of course, missed that
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@tomi-font @kartben
Just added.
d3649ff
to
b0084e2
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
4c68e15
to
fd7f409
Compare
Moves the "Secure Storage" and "Settings" chapters to the Storage folder. Signed-off-by: Andrej Butok <[email protected]>
fd7f409
to
594791a
Compare
Moves the "Secure Storage" and "Settings" chapters to the Storage folder.