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

.dancer file not documented #1580

Closed
LorenzoTa opened this issue Jan 26, 2021 · 9 comments
Closed

.dancer file not documented #1580

LorenzoTa opened this issue Jan 26, 2021 · 9 comments

Comments

@LorenzoTa
Copy link

Hello folks,
at perlmonks I saw a question about the undocumented .dancer file. In brief:

  1. it is really used? I read "It might help move away from the bin/lib directory checks."
  2. why dont name it .dancer2 ?
  3. anyway it needs to be documented

I found the above quote at https://www.endpoint.com/blog/2015/10/28/perl-dancer-conference-2015-report
On teh repository there two issues which refere themself:
#1032 and #1043

The perlmonks post is: https://perlmonks.org/?node_id=11127292 and I can update it if you want.

thanks for looking

@1nickt
Copy link
Contributor

1nickt commented Mar 16, 2021

@LorenzoTa Work is under way to use the .dancer file to identify the root dir of the app and remove the need for FindBin etc.

@LorenzoTa
Copy link
Author

hello, it get documented? I still dont find it in the documentation.. perhaps 'cause of my poor search fu

@xsawyerx
Copy link
Member

Indeed, this is a mistake.

@cromedome and I spoke about refreshing the rewritten documentation and merging it. I've added this as an item to the list I maintain on what to add to that documentation.

I hope to review this documentation before the end of the week. If you have a suggestion on how to phrase this, please do share. :)

@LorenzoTa
Copy link
Author

thanks for looking xsayerx,

"If you have a suggestion on how to phrase this, please do share. :)"

i really have no idea of the matter, just the will to see this great software well documented, and a perl lover :)

@xsawyerx
Copy link
Member

I can now say that the documentation is actively being worked on! :)

@LorenzoTa
Copy link
Author

xsawyerx: for sure due to my ignorance, but I cannot find the branch where the documentation is actively being worked on: could you be so kind to point me there?
thanks

@cromedome
Copy link
Contributor

@LorenzoTa I'd entertain a PR for documentation about this. The code is there, the docs are not. Feel free to send a PR for the current docs, or look at #1069. That's still a ways from completion though!

@LorenzoTa
Copy link
Author

Dear @cromedome thanks for still looking at this. I do not feel comfortable to send a PR for the documentation as I dont know well this framework. More: I still do not understand if the file .dancer is really used.

I still find it referenced in the Core/Role/HasLocation.pm and in its test.

It is created bootstrapping a new Dancer2 application but again, I do not understand if it is really used or usefull.

If yes a short sentence in the Doc, like: .dancer this file is created to help Dancer2 to find the root path of the current application should be placed under the BOOTSTRAPPING A NEW APP section of the manual.

If it is not needed then it should be removed from the bootstrap skeleton and from the above mentioned module.

Sorry but I doubt I can give more help :)

thanks for your work
lorenzo

@cromedome
Copy link
Contributor

#1683 was created to address this.

cromedome added a commit that referenced this issue Oct 9, 2023
    [ BUG FIXES ]
    * GH #1663: Allow overriding of prefix in add_route (GeekRuthie)
    * GH #1675: Stringify VERSION_FROM correctly in Makefile.PL (Jason
      A. Crome)
    * GH #1677: Don't deserialize multipart form data on post (Emil
      Perhinschi)
    * GH #1694: Update JS assets in Dancer2 app skel (Jason A. Crome)

    [ ENHANCEMENTS ]
    * PR #1682: Bump minimum version of Perl to 5.14 (Jason A. Crome)

    [ DOCUMENTATION ]
    * GH #1580: Document the purpose of the .dancer file (Jason A. Crome)
    * GH #1669: Show correct usage of Dancer2::Core::Error (GeekRuthie)
    * GH #1674: Fix POD for input_handle() (mauke)
    * GH #1414: Add documentation resources to the doc map (Jason A.
      Crome, Yanick Champoux)
    * PR #1684: Remove shumphrey from core developers (Steven Humphrey)
    * GH #1685: Document the versioning scheme and Dancer2 release
      process (Jason A. Crome)
    * PR #1688: Fixed various bugs/issues in Dancer2 Pod (Jason A. Crome)
    * PR #1691: Update the contribution guidelines (Jason A. Crome)
    * PR #1692: Change README extension .mkdn -> .md (Jason A. Crome)

    [ DEPRECATED ]
    * GH #1645: Deprecated Dancer2::Test (Jason A. Crome)
    * GH #1646: Deprecated keyword: push_header (Jason A. Crome)
    * GH #1647: Deprecated keyword: header (Jason A. Crome)
    * GH #1648: Deprecated keyword: headers (Jason A. Crome)
    * GH #1649: Deprecated keyword: context (Jason A. Crome)
    * GH #1650: Deprecated: splat/capture named placeholders (Jason A.
      Crome)
    * GH #1651: Deprecated core Request instance method:
      request->dispatch_path (Jason A. Crome)
    * GH #1652: Deprecated keyword in plugins: plugin_setting (Jason A.
      Crome)
    * GH #1653: Deprecated keyword in plugins: dancer_app (Jason A. Crome)
    * GH #1654: Deprecated keyword in plugins: request (Jason A. Crome)
    * GH #1655: Deprecated keyword in plugins: var (Jason A. Crome)
    * GH #1656: Deprecated keyword in plugins: hook (Jason A. Crome)

    [ MISC ]
    * GH #1659: Rename `master` branch to be `main` (Yanick Champoux)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants