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

Break out docs into new structure, and add --man=faq and --man=cookbook options #5

Closed
petdance opened this issue Mar 26, 2017 · 10 comments
Assignees
Milestone

Comments

@petdance
Copy link
Collaborator

I've found it very difficult to maintain docs in ack. We also need more granular docs.

Create a new doc structure App::Ack::Docs::*. To start with, we'll have

  • App::Ack::Docs::Man -- current manual
  • App::Ack::Docs::FAQ
  • App::Ack::Docs::Cookbook -- A list of examples and recipes for using ack (I'm not set on the name "Cookbook")

All these docs will need to get put into the ack standalone. They'll get put at the end of the file during squashing.

The ack --man switch will now take arguments, so you can say ack --man=faq and ack --man=cookbook.

@petdance petdance added this to the 2.999_01 milestone Mar 26, 2017
@petdance petdance self-assigned this Mar 27, 2017
@petdance
Copy link
Collaborator Author

This may not work out so well. I'm looking into Pod::Usage and its rules. http://search.cpan.org/~marekr/Pod-Usage-1.69/lib/Pod/Usage.pm

@petdance
Copy link
Collaborator Author

@petdance
Copy link
Collaborator Author

ack-standalone has to work on itself without loading any external .pm files.

Write a .t file to make sure --man and --faq work on both ack and ack-standalone.

@petdance
Copy link
Collaborator Author

Some options are loaded in ack, and some in App::Ack::ConfigLoader. Remove any extraneous stuff in ConfigLoader.

@petdance
Copy link
Collaborator Author

The docs have been broken out in 81ce3cd but there are still problems to fix.

  1. Do we want to still have ack use perldoc for its rendering?

  2. If so, how do we handle the tests that complain if someone's perldoc is not set up correctly?

t/ack-man.t is TODOed because of these questions.

@petdance petdance removed their assignment Apr 9, 2017
@petdance
Copy link
Collaborator Author

petdance commented May 11, 2017

Yes, we need to use perldoc / Pod::Usage.

@petdance petdance self-assigned this May 11, 2017
@petdance
Copy link
Collaborator Author

This split-up form of manual also will help us with the ack3 redesign where we will have different HTML pages for different manual sections.

@petdance petdance changed the title Break out docs into their own module structure Break out docs into new structure, and add --man=intro, --man=faq and --man=cookbook options Jul 23, 2017
@petdance petdance changed the title Break out docs into new structure, and add --man=intro, --man=faq and --man=cookbook options Break out docs into new structure, and add --man=faq and --man=cookbook options Jul 30, 2017
@petdance
Copy link
Collaborator Author

I have the --man, --faq and --cookbook working for ack-standalone, but ack-man.t fails.

@petdance
Copy link
Collaborator Author

Looks like perldoc isn't happy about the removal of $ENV{PATH}. Needs more exploration.

@petdance
Copy link
Collaborator Author

petdance commented Jan 2, 2018

Remaining problems are now in #122.

@petdance petdance closed this as completed Jan 2, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant