Skip to content
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

feat: add doc for typescript auth helpers #94

Merged
merged 8 commits into from
Jan 20, 2021

Conversation

haijian-vaadin
Copy link
Contributor

@haijian-vaadin haijian-vaadin commented Jan 7, 2021

This PR copies the commit done in the old doc repo for typescript authentication helpers.

For vaadin/flow-and-components-documentation#1402.

@netlify
Copy link

netlify bot commented Jan 7, 2021

✔️ Deploy preview for vaadin-docs-preview ready!

🔨 Explore the source changes: 5f75e38

🔍 Inspect the deploy logs: https://app.netlify.com/sites/vaadin-docs-preview/deploys/600887b1b134860008cf9f12

😎 Browse the preview: https://deploy-preview-94--vaadin-docs-preview.netlify.app

@jouni
Copy link
Member

jouni commented Jan 11, 2021

@haijian-vaadin, please update from master, to get the Vale check running correctly. Do a rebase preferably, if possible. Otherwise you need to touch each .asciidoc file to trigger the check for them.

Copy link
Member

@jouni jouni left a comment

Choose a reason for hiding this comment

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

It pains me a little bit, that there are two login-view.ts files that have some amount of the same code.

I wonder if there’s a way to avoid the duplication? I didn’t look in detail if that would make sense, though – maybe the examples are different enough that the copy-pasted code doesn’t hurt.

@haijian-vaadin
Copy link
Contributor Author

Oh, finally it's all green, no more Vale errors.

@joheriks
Copy link

Got this TS error when running mvn spring-boot:run:

ERROR in [at-loader] ./frontend/demo/fusion/authentication/handle-session-expiration/login-overlay.ts:10:11 
    TS6133: 'onSuccess' is declared but its value is never read.

@joheriks
Copy link

I noticed an error in the build:

error /Users/joheriks/vaadin/docs/articles/fusion/security/fusion-security-custom-spring-login.asciidoc, line 9 - level 0 sections can only be used when doctype is book

Seems to be because of the line just before:

ifdef::env-github[:outfilesuffix: .asciidoc]

What is this for, is it needed?

@haijian-vaadin
Copy link
Contributor Author

Confirmed with the doc team, it's not needed, I removed it.

@joheriks
Copy link

joheriks commented Jan 19, 2021

Confirmed with the doc team, it's not needed, I removed it.

There are some one sentence per line and similar Vale errors in that file (fusion-security-custom-spring-login.asciidoc) now reported that could be fixed on (Vale errors blink because they are cleared between checks and only reported for files touched in the last commit).

@@ -29,6 +29,7 @@ repo
[sS]crollbars?
[sS]croller
[sS]ervlets?
src
Copy link
Member

Choose a reason for hiding this comment

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

We should not introduce this change. Where is this causing problems? I believe all occurences of this “word” should either be inside code snippets or [filename]## classes, and therefore not part of the linting checks.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't remember, I think I got a Vale error. I can remove this and let's see.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Comment on lines 17 to 19
JWT
Karaf
LDAP
Copy link
Member

Choose a reason for hiding this comment

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

These (JWT and LDAP) should be added to Abbr.yml, not here, if we want to make these as exceptions of abbreviations that we don’t need to explain. But I’m hesitant in adding them, because I would not expect all readers to know what they mean.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

thanks for the comment, done

@haijian-vaadin haijian-vaadin merged commit b21ee3a into master Jan 20, 2021
@haijian-vaadin haijian-vaadin deleted the haijian/add-auth-doc branch January 20, 2021 20:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants