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.

Sign up for GitHub

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

Jump to bottom

Consolidate routing-dsl index #1600

Merged
merged 1 commit into from Dec 22, 2017
Merged

Consolidate routing-dsl index #1600

merged 1 commit into from Dec 22, 2017

Conversation

raboof
Copy link
Member

@raboof raboof commented Dec 6, 2017 •
edited

Refs #1290

Needs a paradox with lightbend/paradox#170 to remove scala-specific elements from
the indexes

@raboof raboof mentioned this pull request Dec 6, 2017
Closed
@akka-ci akka-ci added validating PR that is currently being validated by Jenkins needs-attention Indicates a PR validation failure (set by CI infrastructure) and removed validating PR that is currently being validated by Jenkins labels Dec 6, 2017
@akka-ci
Copy link

akka-ci commented Dec 6, 2017

Test FAILed.

@raboof
Copy link
Member Author

raboof commented Dec 6, 2017

(CI fails because we haven't released a paradox with lightbend/paradox#170 yet)

@akka-ci akka-ci added validating PR that is currently being validated by Jenkins needs-attention Indicates a PR validation failure (set by CI infrastructure) and removed needs-attention Indicates a PR validation failure (set by CI infrastructure) validating PR that is currently being validated by Jenkins labels Dec 7, 2017
@akka-ci
Copy link

akka-ci commented Dec 7, 2017

Test FAILed.

@akka-ci akka-ci added validating PR that is currently being validated by Jenkins needs-attention Indicates a PR validation failure (set by CI infrastructure) and removed needs-attention Indicates a PR validation failure (set by CI infrastructure) validating PR that is currently being validated by Jenkins labels Dec 7, 2017
@akka-ci
Copy link

akka-ci commented Dec 7, 2017

Test FAILed.

jlprat
jlprat approved these changes Dec 8, 2017
View reviewed changes
Copy link
Member

@jlprat jlprat left a comment

Choose a reason for hiding this comment

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

LGTM

docs/src/main/paradox/scala/http/routing-dsl/index.md

See @ref[HttpApp Bootstrap](HttpApp.md) for more details about setting up a server using this approach.

<a id="long-example"></a>
@@@ div { .group-scala }
Copy link
Member

Choose a reason for hiding this comment

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

Pity to have this only for Scala, but this can come in another PR

Copy link
Member Author

Choose a reason for hiding this comment

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

Added #1639

@richardimaoka richardimaoka mentioned this pull request Dec 14, 2017
Closed
ktoso
ktoso reviewed Dec 14, 2017
View reviewed changes
docs/src/main/paradox/scala/http/routing-dsl/path-matchers.md
@@ -1,3 +1,10 @@
@@@ div { .group-java }

This DSL is only relevant when using the Scala API.
Copy link
Member

Choose a reason for hiding this comment

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

Should we then hide it completely maybe?

Copy link
Member Author

Choose a reason for hiding this comment

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

The question is what should happen when you are on the Scala version of this page and switch to the Java version.

We could go fancy and use page attributes to mark the whole page as scala-only, and then generate a page that does a redirect (though to where?) for when you hit the the java version (lightbend/paradox#169 might be an inspiration)... but that seems kind of tricky, this should be nice and simple for now :).

@raboof raboof mentioned this pull request Dec 15, 2017
Merged
@jlprat
Copy link
Member

jlprat commented Dec 19, 2017

@raboof could you resolve the conflicts for this? I'd love to have this merged, as I'm working on the parameter directives unification and I'd need to do the same with case-class-extraction.md

@raboof
Copy link
Member Author

raboof commented Dec 19, 2017

@jlprat I'd be happy to resolve the conflicts, but for this to actually work we'd need a paradox version with lightbend/paradox#170 to be released.. I guess we could temporarily merge without that, but it would show the Scala-only sections in the Java version of the documentation.

@jlprat
Copy link
Member

jlprat commented Dec 19, 2017

I copied your changes for that page to #1658 so you can wait to merge this one if you want :)

@akka-ci akka-ci added validating PR that is currently being validated by Jenkins needs-attention Indicates a PR validation failure (set by CI infrastructure) and removed needs-attention Indicates a PR validation failure (set by CI infrastructure) validating PR that is currently being validated by Jenkins labels Dec 21, 2017
@akka-ci
Copy link

akka-ci commented Dec 21, 2017

Test FAILed.

@raboof
Consolidate routing-dsl index
bb87788 
Needs a paradox update to remove scala-specific elements from
the indexes
@akka-ci akka-ci added validating PR that is currently being validated by Jenkins tested PR that was successfully built and tested by Jenkins and removed needs-attention Indicates a PR validation failure (set by CI infrastructure) validating PR that is currently being validated by Jenkins labels Dec 21, 2017
@akka-ci
Copy link

akka-ci commented Dec 21, 2017

Test PASSed.

@jrudolph
Copy link
Member

Great, thanks @raboof for making sure we improve paradox as we go 👍

@jrudolph jrudolph merged commit 0758f7f into master Dec 22, 2017
@jrudolph jrudolph deleted the routingDslIndex branch December 22, 2017 08:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ktoso ktoso ktoso left review comments

@jlprat jlprat jlprat approved these changes

Assignees
No one assigned
Labels
tested PR that was successfully built and tested by Jenkins
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@raboof @akka-ci @jlprat @jrudolph @ktoso