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

Documentation reorganization #2381

Merged
merged 13 commits into from
Sep 14, 2017
Merged

Documentation reorganization #2381

merged 13 commits into from
Sep 14, 2017

Conversation

gilberto-torrezan
Copy link
Contributor

@gilberto-torrezan gilberto-torrezan commented Sep 12, 2017

Moved docs to subfolders, added article headers used by the docs site builder script.


This change is Reviewable

@SomeoneToIgnore
Copy link
Contributor

Reviewed 76 of 99 files at r1, 5 of 5 files at r2.
Review status: 41 of 50 files reviewed at latest revision, 4 unresolved discussions, some commit checks failed.


flow-documentation/Overview.asciidoc, line 32 at r2 (raw file):

** <<application-structure/tutorial-importing#,Importing html/javascript>>
** <<application-structure/tutorial-ways-of-importing#,Ways of importing the dependencies>>
** <<application-structure/tutorial-dependency-filter#,Modifying how dependencies are loaded with DependencyFilters>>

This file is not in application-structure folder.

Hi @hezamu , thanks for the restructure idea.
Can you please fix a few issues that I've found?
You can run TestTutorialCodeCoverage locally to verify that there are no issues with the docs.

Currently it fails, pointing out a number of mistakes.
They are mostly about missing code files, those should be adjusted too: @CodeFor annotation is responsible for that.
Alternatively, you can adjust the test to search for the corresponding source file instead of looking at some particular path, that might be faster way to fix it :)


flow-documentation/application-structure/tutorial-importing.asciidoc, line 3 at r2 (raw file):

---
title: Importing HTML and JavaScript
order: 4

This is listed as #3 in Overview.asciidoc, is it ok?


flow-documentation/application-structure/tutorial-ways-of-importing.asciidoc, line 1 at r2 (raw file):

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

No header here?


flow-documentation/element-api/tutorial-user-input.asciidoc, line 2 at r2 (raw file):

---
title: etrieving User Input

Typo.


Comments from Reviewable

@SomeoneToIgnore
Copy link
Contributor

Review status: 41 of 50 files reviewed at latest revision, 8 unresolved discussions, some commit checks failed.


flow-documentation/Overview.asciidoc, line 62 at r2 (raw file):

* Routing and navigation
** <<routing/tutorial-routing-annotation#,Defining Routes with @Route>>
** <<routing/tutorial-routing-lifecycle#,Navigation Lifecycle>>

I cannot find the file at all in this commit.


flow-documentation/Overview.asciidoc, line 85 at r2 (raw file):

** <<miscellaneous/tutorial-history-api#,The History API>>
** <<miscellaneous/tutorial-dynamic-content#,Dynamic Content>>
** <<miscellaneous/tutorial-loading-indicator#,The Loading Indicator>>

There are 2 more files in the miscellaneous folder, is it ok?


flow-documentation/application-structure/tutorial-bootstrap.asciidoc, line 3 at r2 (raw file):

---
title: Modifying the bootstrap page
order: 5

This has the same order as tutorial-dependency-filter, is it ok?


flow-documentation/routing/tutorial-routing-annotation.asciidoc, line 3 at r2 (raw file):

---
title: Defining Routes With @Route
order: 7

This is listed as #1 in Overview, is it ok? At least 2 more from the same section has the same thing with their order number.


Comments from Reviewable

@SomeoneToIgnore
Copy link
Contributor

Reviewed 18 of 99 files at r1.
Review status: all files reviewed at latest revision, 8 unresolved discussions, some commit checks failed.


Comments from Reviewable

@SomeoneToIgnore
Copy link
Contributor

Reviewed 12 of 99 files at r1, 99 of 99 files at r3.
Review status: all files reviewed at latest revision, 8 unresolved discussions.


Comments from Reviewable

@SomeoneToIgnore
Copy link
Contributor

Review status: all files reviewed at latest revision, 7 unresolved discussions.


flow-documentation/Overview.asciidoc, line 85 at r2 (raw file):

Previously, SomeoneToIgnore (Kirill Bulatov) wrote…

There are 2 more files in the miscellaneous folder, is it ok?

Now only one remains: tutorial-service-init-listener.asciidoc


Comments from Reviewable

@gilberto-torrezan
Copy link
Contributor Author

Review status: all files reviewed at latest revision, 7 unresolved discussions, some commit checks failed.


flow-documentation/Overview.asciidoc, line 85 at r2 (raw file):

Previously, SomeoneToIgnore (Kirill Bulatov) wrote…

Now only one remains: tutorial-service-init-listener.asciidoc

Apparently he preferred to move this one under misc instead of the application-structure, because it is an advanced topic. But only Muurimaa knows.


Comments from Reviewable

@hezamu
Copy link
Contributor

hezamu commented Sep 14, 2017

flow-documentation/Overview.asciidoc, line 85 at r2 (raw file):

Previously, gilberto-torrezan (Gilberto Torrezan) wrote…

Apparently he preferred to move this one under misc instead of the application-structure, because it is an advanced topic. But only Muurimaa knows.

I think this was one of the files that wasn't referred to in overview, so I just picked misc. Please move it to a correct location.


Comments from Reviewable

@hezamu
Copy link
Contributor

hezamu commented Sep 14, 2017

flow-documentation/Overview.asciidoc, line 32 at r2 (raw file):

Previously, SomeoneToIgnore (Kirill Bulatov) wrote…

This file is not in application-structure folder.

Hi @hezamu , thanks for the restructure idea.
Can you please fix a few issues that I've found?
You can run TestTutorialCodeCoverage locally to verify that there are no issues with the docs.

Currently it fails, pointing out a number of mistakes.
They are mostly about missing code files, those should be adjusted too: @CodeFor annotation is responsible for that.
Alternatively, you can adjust the test to search for the corresponding source file instead of looking at some particular path, that might be faster way to fix it :)

@gilberto-torrezan fixed this already.


Comments from Reviewable

@hezamu
Copy link
Contributor

hezamu commented Sep 14, 2017

flow-documentation/application-structure/tutorial-bootstrap.asciidoc, line 3 at r2 (raw file):

Previously, SomeoneToIgnore (Kirill Bulatov) wrote…

This has the same order as tutorial-dependency-filter, is it ok?

Yes, since that file was moved to application-structure/. You guys know better than me what is the correct order for these articles.


Comments from Reviewable

@hezamu
Copy link
Contributor

hezamu commented Sep 14, 2017

flow-documentation/application-structure/tutorial-importing.asciidoc, line 3 at r2 (raw file):

Previously, SomeoneToIgnore (Kirill Bulatov) wrote…

This is listed as #3 in Overview.asciidoc, is it ok?

See #2401


Comments from Reviewable

@hezamu
Copy link
Contributor

hezamu commented Sep 14, 2017

Fixed ordering to match overview in #2402. Should be good to go after this?

@gilberto-torrezan
Copy link
Contributor Author

Review status: 121 of 134 files reviewed at latest revision, 2 unresolved discussions.


flow-documentation/element-api/tutorial-user-input.asciidoc, line 2 at r2 (raw file):

Previously, SomeoneToIgnore (Kirill Bulatov) wrote…

Typo.

Done.


flow-documentation/routing/tutorial-routing-annotation.asciidoc, line 3 at r2 (raw file):

Previously, SomeoneToIgnore (Kirill Bulatov) wrote…

This is listed as #1 in Overview, is it ok? At least 2 more from the same section has the same thing with their order number.

Done.


Comments from Reviewable

@SomeoneToIgnore
Copy link
Contributor

Reviewed 11 of 99 files at r1, 2 of 99 files at r3, 2 of 2 files at r4, 11 of 11 files at r5, 1 of 1 files at r6.
Review status: all files reviewed at latest revision, all discussions resolved.


Comments from Reviewable

@SomeoneToIgnore
Copy link
Contributor

:lgtm:


Review status: all files reviewed at latest revision, all discussions resolved, some commit checks pending.


Comments from Reviewable

@SomeoneToIgnore SomeoneToIgnore merged commit b1a3d09 into master Sep 14, 2017
@SomeoneToIgnore SomeoneToIgnore deleted the doc_reorg branch September 14, 2017 12:18
@gilberto-torrezan gilberto-torrezan added this to the 1.0.0.alpha1 milestone Sep 21, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants