New documentation from TPRF grant #1721
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some minor cleanup, and the start of some better structure to the core of the manual.
This iteration uses a simple question and answer format to help users both new and old find the correct answers to the questions they have.
We have discouraged the use of the dance keyword for some time; our most basic example should not feature it.
Right now, this is just the installation instructions ripped from the manual, with notes on what else to do.
Next up: introducing core concepts through the Danceyland example.
All of these items are subsections of the manual, and as such, should be namespaced properly.
This info belongs in the Deployment section of the manual; having it in the core of the manual doesn't make sense.
This is step one in presenting certain topics to developers as more advanced dance moves. There is more rewriting and restructuring to do here.
Still a few TODO items to resolve.
All keywords should be documented now; t/dsl/pod.t is now passing. A lot of copy has been reviewed and edited, and most TODO items removed. This needs one final editing pass, and to finish linking keywords to where they appear in the manual.
Reduced the scope of the tutorial; the goal is to help accomplish something in a short amount of time, not to be something production ready. To that end, the relentless removal of content continues. Updated "Where to Go from Here" to match some of the changes recently made to tutorial code. This guide diverges from the current state of tutorial code, however, and needs to be updated to reflect that.
Replaced usage of Dancer2::Plugin::Database with a DBIx::Class based example. Restructured parts of the tutorial to fit this change accordingly.
Originally we were using sessions to pass messages between routes across requests. Removing that as I don't think it adds much to the tutorial; I think dealing with sessions in the context of authentication is good enough.
Keywords are linked back to where they appear in the Dancer2 manual, and keywords link to related keywords within the keyword document.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is the result of a TPRF grant for rewriting the Dancer2 documentation. Highlights include:
Dancer2::Manual)Dancer2::Manual::namespaceThis list is non-exhaustive. I relentlessly cut content out from the old manual; some of it outdated, some of it unnecessary. Hopefully I didn't get too overly aggressive.
I squashed about 40 commits already. If anyone would like me to squash this further, just say the word.
Thanks to Sawyer for being my grant manager on this!