Skip to content

docs: improve Tutorial v4.3#6900

Merged
kenjis merged 18 commits intocodeigniter4:4.3from
kenjis:fix-docs-tutorial-4.3
Dec 3, 2022
Merged

docs: improve Tutorial v4.3#6900
kenjis merged 18 commits intocodeigniter4:4.3from
kenjis:fix-docs-tutorial-4.3

Conversation

@kenjis
Copy link
Copy Markdown
Member

@kenjis kenjis commented Nov 24, 2022

Description

  • Use validateData() instead of validate() because it is more secure.
    • If we use validate(), we cannot know which data is validated.
  • Use new validation_list_errors().
  • Use set_value() to show old input data.
  • Update description for v4.3.
  • Update screenshots.

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

Remove the word `here`.
Make the path relative.
The slug should be unique.
Use validateData() instead of validate() because it is more secure.
If we use validate(), we cannot know which data is validated.

Use new validation_list_errors().

Use set_value() to show old input data.

Update description for v4.3.
@kenjis kenjis added documentation Pull requests for documentation only 4.3 labels Nov 24, 2022
@kenjis kenjis marked this pull request as draft November 24, 2022 10:44
Copy link
Copy Markdown
Member

@MGatner MGatner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You used php:func: for a number of internal functions. I thought that would create a link out to the PHP docs? Or am I thinking of another syntax?

@kenjis
Copy link
Copy Markdown
Member Author

kenjis commented Nov 24, 2022

I thought that would create a link out to the PHP docs?

No. It creates a link to the .. php:function:: xxx() page in the user guide.

@kenjis kenjis force-pushed the fix-docs-tutorial-4.3 branch from 9feb670 to 94f6d84 Compare November 25, 2022 05:20
@kenjis kenjis force-pushed the fix-docs-tutorial-4.3 branch from 94f6d84 to 510441f Compare November 25, 2022 05:25
@kenjis kenjis marked this pull request as ready for review November 25, 2022 05:30
Copy link
Copy Markdown
Member

@MGatner MGatner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! I haven't walked through the tutorial, might be good to do before 4.3 goes live at some point.

@kenjis
Copy link
Copy Markdown
Member Author

kenjis commented Nov 25, 2022

I pushed my working repository:
https://github.com/kenjis/ci4-news

Copy link
Copy Markdown
Contributor

@datamweb datamweb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!
Verry good.

@MGatner
Copy link
Copy Markdown
Member

MGatner commented Dec 2, 2022

@kenjis Please proceed; I won't get to walk through this soon.

@kenjis kenjis merged commit d169485 into codeigniter4:4.3 Dec 3, 2022
@kenjis kenjis deleted the fix-docs-tutorial-4.3 branch December 3, 2022 00:31
@kenjis kenjis mentioned this pull request Dec 3, 2022
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Pull requests for documentation only

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants