docs: reorganize (part 2) #841

kenjis · 2023-09-19T01:35:45Z

Description
The current documentation is difficult to understand where it is written.
See #839

add section "User Management"
add pages
move files to the section directories
tweaks

Online Demo: https://datamweb.github.io/shield/

Checklist:

Securely signed commits
[] Component(s) with PHPDoc blocks, only if necessary or adds value
[] Unit testing, with >80% coverage
User guide updated
[] Conforms to style guide

datamweb

Generally good.
Only I prefer to have section acknowledgements in these documents.

datamweb · 2023-09-19T12:56:14Z

docs/getting_started/install.md

+
+    If you get `Specified key was too long` error:
+
+    1. Use InnoDB, not MyISAM.


Suggested change

If you get `Specified key was too long` error:

1. Use InnoDB, not MyISAM.

I don't think it is necessary now with the changes applied in the migration file.

datamweb · 2023-09-19T12:58:06Z

docs/getting_started/install.md

+6. Configure **app/Config/Email.php** to allow Shield to send emails.
+
+    ```php
+    <?php


Is it(<?php) added to all existing codes?

This is a whole file of it. So it seems better to have <?php.
I don't think <?php should be added to all existing codes.

datamweb · 2023-09-19T13:01:59Z

docs/quick_start_guide/using_session_auth.md

-# Authentication Flow
+# Using Session Authenticator
+
+**Session** authenticator provides traditional Email/Password authentication.


Email/Password It's probably a term, but my understanding of this at first glance is that Shield only supports email/password (username/password, mobile/password, etc.).

Changed to ID/Password.

datamweb · 2023-09-19T13:04:04Z

docs/quick_start_guide/using_session_auth.md

@@ -27,7 +29,7 @@ public array $redirects = [

 ### Configure Remember-me Functionality

-Remember-me functionality is enabled by default for the `Session` authenticator. While this is handled in a secure manner, some sites may want it disabled. You might also want to change how long it remembers a user and doesn't require additional login.
+Remember-me functionality is enabled by default. While this is handled in a secure manner, some sites may want it disabled. You might also want to change how long it remembers a user and doesn't require additional login.


which one? Remember me
or Remember-me.
please choose one everywhere.

Remember-me. Done.

datamweb · 2023-09-19T13:07:39Z

docs/references/controller_filters.md

+> **Note**
+> These filters are already loaded for you by the registrar class located at **src/Config/Registrar.php**.


I recently saw a video of an instructor resetting the filters(app/filters.php). Therefore, I prefer to add this issue in line 3.

Moved the note up.

datamweb · 2023-09-19T13:08:42Z

docs/references/magic_link_login.md

+# Magic Link Login
+
+Magic Link Login is a feature that allows users to log in if they forget their
+password.


Or use as a one-time password.

Using Magic Link Login as a one-time password authentication?
I don't know if it is supposed to be used for anything other than forgotten passwords.

and move a section.

and move the existing contents.

For consistency.

and move the existing content.

and move the existing contents.

For consistency.

To stand it out.

kenjis · 2023-09-19T20:41:17Z

Added Acknowledgements.

kenjis added the documentation Improvements or additions to documentation label Sep 19, 2023

kenjis marked this pull request as draft September 19, 2023 01:36

kenjis force-pushed the docs-reorganize-2 branch from 1ee5175 to aea4654 Compare September 19, 2023 01:41

kenjis marked this pull request as ready for review September 19, 2023 01:57

datamweb approved these changes Sep 19, 2023

View reviewed changes

kenjis changed the title ~~docs: reorganize (part 2/2)~~ docs: reorganize (part 2) Sep 19, 2023

kenjis added 24 commits September 20, 2023 05:13

docs: extract "Controller Filters"

e977f0e

docs: remove "the"

159295b

docs: add list of Authenticators

b42159c

docs: add section title

a937a80

docs: change first letters of keywords to capital letters

5c636e5

docs: change page titles

91e094d

and move a section.

docs: add "Using Authorization"

a3d84c8

and move the existing contents.

docs: replace "Magic Login Links" with "Magic Link Login"

2952e1f

For consistency.

docs: add page for Magic Link Login

0d3c652

and move the existing content.

docs: add "Controller Filters"

0ffd7c6

and move the existing contents.

docs: change filename

228ad48

docs: add descriptions

6f260fe

docs: remove using_access_tokens_auth.md

7008664

docs: change section title

85fd665

docs: add links

adf6024

docs: add "Getting Started > Configuration"

cf1e5f1

docs: update link

80e46eb

docs: fix section title

604b390

docs: remove duplicated "the"

32ab5ca

docs: move Configuration to References

38fb0da

docs: add explanation to configuration.md

ae56615

docs: add empty line

969e47c

docs: move configuration.md to "Getting Started"

d7008e8

docs: add Configuration in magic_link_login.md

a6a6d12

kenjis added 18 commits September 20, 2023 05:14

docs: fix rebase mistake

14a607c

docs: add empty lines and line breaks

dfe0448

docs: improve descriptions for Filters

331a81e

docs: add line break after **Note**

ba72bdd

docs: add HmacSha256 authenticator

a33cf5a

docs: move "Managing Users" to "Guides"

6584605

docs: add section "User Management" and change section order

ae30aac

docs: change sub section order

62685e8

docs: move files to references/

e523415

docs: update links

780c57b

docs: fix link text

564352a

docs: add about app/Config/AuthToken.php

588d17d

docs: remove out-of-dated error description

2e48eca

docs: replace "remember me" with remember-me

2316f76

For consistency.

docs: replace Email/Password with ID/Password

ab65804

docs: add section title

4f7d592

docs: move note up

cd757a2

To stand it out.

docs: add link to CI4 user guide

10d5f4d

kenjis force-pushed the docs-reorganize-2 branch from aea4654 to 10d5f4d Compare September 19, 2023 20:30

kenjis added 2 commits September 20, 2023 05:37

docs: make page title shorter

f40a5ee

docs: add Acknowledgements

52d24fd

docs: update and move description for Authenticators

d8c89bc

kenjis merged commit 6be3162 into codeigniter4:develop Sep 22, 2023
1 check passed

kenjis deleted the docs-reorganize-2 branch September 22, 2023 08:45

kenjis mentioned this pull request Sep 22, 2023

docs: reorganize (part 3/3) #847

Merged

2 tasks

kenjis added the enhancement New feature or request label Oct 7, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: reorganize (part 2) #841

docs: reorganize (part 2) #841

kenjis commented Sep 19, 2023 •

edited by datamweb

datamweb left a comment

datamweb Sep 19, 2023

datamweb Sep 19, 2023

kenjis Sep 19, 2023

datamweb Sep 19, 2023

kenjis Sep 19, 2023

datamweb Sep 19, 2023

kenjis Sep 19, 2023

datamweb Sep 19, 2023

kenjis Sep 19, 2023

datamweb Sep 19, 2023

kenjis Sep 19, 2023

datamweb Sep 19, 2023

kenjis Sep 19, 2023

kenjis commented Sep 19, 2023


		If you get `Specified key was too long` error:

		1. Use InnoDB, not MyISAM.

		> Note
		> These filters are already loaded for you by the registrar class located at src/Config/Registrar.php.

docs: reorganize (part 2) #841

docs: reorganize (part 2) #841

Conversation

kenjis commented Sep 19, 2023 • edited by datamweb

datamweb left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kenjis commented Sep 19, 2023

kenjis commented Sep 19, 2023 •

edited by datamweb