From 139c7f8e1699b408d56964c07a121bd1eed080c0 Mon Sep 17 00:00:00 2001 From: Mike van Riel Date: Wed, 18 Sep 2024 08:11:04 +0200 Subject: [PATCH] Release page with authentication information, stressing the need to re-authenticate every time the application opens --- .../features/layers-with-authentication.md | 12 +++++++++++- docs/stylesheets/extra.css | 2 +- mkdocs.yml | 2 +- 3 files changed, 13 insertions(+), 3 deletions(-) diff --git a/docs/docs/developers/features/layers-with-authentication.md b/docs/docs/developers/features/layers-with-authentication.md index 69d7bd5..433b6d0 100644 --- a/docs/docs/developers/features/layers-with-authentication.md +++ b/docs/docs/developers/features/layers-with-authentication.md @@ -76,7 +76,17 @@ file. This is because authentication status is a **temporary state** that should a project is loaded, the authentication process must be reinitiated for protected layers, ensuring that credentials are entered securely and as needed. -## 7. Warnings and User Flow +## 7. Need to re-authenticate reopening the application + +A key implication of this design is that users will need to re-authenticate any protected layers every time they reopen +the application or load a saved project file. Since credentials are never stored in the project file for security +reasons, the system requires users to provide valid credentials again when the project is reloaded. + +This approach ensures that sensitive credentials are handled securely, but it also means that re-authentication is +necessary whenever a protected layer is accessed in a new session. Users should be aware that any protected layers will +initially be in a non-visible state until the required credentials are provided. + +## 8. Warnings and User Flow The current user flow for managing layer authentication includes: diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index dfe4346..49df1cb 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -1,5 +1,5 @@ .md-typeset h2 { - margin-top: 3.2rem; + margin-top: 2rem; } /*****************************************************************************/ diff --git a/mkdocs.yml b/mkdocs.yml index c066e13..ac1c3a7 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -15,6 +15,7 @@ nav: - 'docs/developers/features/embedding.md' - 'docs/developers/features/floating-origin.md' - 'docs/developers/features/layers.md' + - 'docs/developers/features/layers-with-authentication.md' - 'docs/developers/features/geojson.md' - 'Packages': - 'docs/developers/packages/index.md' @@ -55,7 +56,6 @@ not_in_nav: | _*.md docs/developers/core-concepts.md docs/developers/projects.md - docs/developers/features/layers-with-authentication.md site_name: "" # Empty on purpose for style purposes theme: