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

Provide an Airline user guide #35

Open
35 of 40 tasks
rvesse opened this issue Nov 26, 2015 · 3 comments
Open
35 of 40 tasks

Provide an Airline user guide #35

rvesse opened this issue Nov 26, 2015 · 3 comments
Assignees
@rvesse
Labels
documentation Documentation Changes enhancement Proposed Enhancement/Feature help Help System user-experience Improves user experience
Milestone
Unscheduled

Comments

@rvesse
Copy link
Owner

rvesse commented Nov 26, 2015 •
edited
Loading

Currently Airline is fairly esoteric with no real user guide to teach people how to use the library

We should use GitHub pages and Jekyll to start putting together such a user guide

Content to create:

  • Core Annotations
    • @Cli
    • @Command
    • @Groups and @Group
    • @Parser and @Alias
      • New force built in feature
      • resource locators for user aliases
    • @Option
    • @Arguments
  • Restrictions
    • Range Restriction Annotations
    • @Partials
    • Global Restriction
    • Custom restrictions
    • Annotations from Add additional common restrictions #73
      • @PortRange and @PortRanges
      • @StartsWith
      • @EndsWith
      • @File and @Directory
      • @Positive and @Negative
      • @LengthRange and @ExactLength
  • Help System
    • Custom help sections
    • Hints
    • Formats
    • Bash Completion
  • Error Handling
  • Parser
    • Various new features introduced to @Parser
    • Option Parsing
    • User Defined Aliases
    • Resource Locators
      • Custom Resource Locators
  • Unit Testing
  • Maven Plugin
    • validate goal
    • generate goal
  • Fluent API
    • CliBuilder
    • ParserBuilder
@rvesse rvesse added enhancement Proposed Enhancement/Feature help Help System labels Nov 26, 2015
@rvesse rvesse added this to the 2.1.1 milestone Nov 26, 2015
@rvesse rvesse self-assigned this Nov 26, 2015
@rvesse
Copy link
Owner Author

rvesse commented Dec 1, 2015

Early stub is up at http://rvesse.github.io/airline/ though it is a long ways off of being complete

rvesse added a commit that referenced this issue Dec 2, 2015
@rvesse
Continue work on first draft of User Guide (#35)
47367d9 
- First draft of `@Command` and `@Option` pages
- Add Supported Types page
- Add stub for Inheritance & Composition and Parser pages
- Add include for marking a paragraph as an alert which will highlight
  the paragaraph in yellow
- Updated navigation
rvesse added a commit that referenced this issue Dec 2, 2015
@rvesse
Slight tweaks to User Guide (#35)
0c6ef4a 
- Add `@Discussion` annotation stub
- Mention use of other annotations on the `@Command` page
- Fix CSS styling for when code is linked
rvesse added a commit that referenced this issue Dec 3, 2015
@rvesse
Further document annotations (#35)
fc6a284 
- Document `@Arguments`
- Documents `@Discussion`
- Stub for `@Group`
- Partial document for `@Cli`
- Add terminology definitions to main page of user guide
- Slightly tweak some examples
rvesse added a commit that referenced this issue Dec 3, 2015
@rvesse
Various minor improvments (#35, #40)
2cee08c 
- Mark all CLI definition annotation as @documented
- Mark defunct fields of @arguments as deprecated (#40)
- Add more examples that pertain to the user guide (#35)
rvesse added a commit that referenced this issue Dec 3, 2015
@rvesse
Add missing license headers on examples (#35)
9221a37
rvesse added a commit that referenced this issue Dec 3, 2015
@rvesse
Update documentation (#35)
47097e2 
Reference the new website and user guide in the README
rvesse added a commit that referenced this issue Dec 16, 2015
@rvesse
Continue work on user guide (#35)
4c9f2ae 
- Further explain first command example on opening page of User Guide
- Start adding a CLI example on opening page of User Guide
- Restructure website home page and user guide entry page slightly
@rvesse rvesse mentioned this issue Jan 4, 2016
Closed
@rvesse rvesse added the documentation Documentation Changes label Jan 4, 2016
rvesse added a commit that referenced this issue Jan 12, 2016
@rvesse
Add placeholder TODOs into the User Guide (#35)
9298fdd
rvesse added a commit that referenced this issue Jan 15, 2016
@rvesse
Finish first draft of main page of User Guide (#35)
e68cbbc
rvesse added a commit that referenced this issue Jan 15, 2016
@rvesse
More user guide pages (#35)
47726c3 
- Index page for Airline in Practise section
- Example of creating a custom type converter on Supported Types page
rvesse added a commit that referenced this issue Jan 15, 2016
@rvesse
Notes on using a custom parser (#35)
fe0335f
rvesse added a commit that referenced this issue Jan 15, 2016
@rvesse
More work on annotations pages (#35)
47b2ec6 
- Wrote most of the `@Parser` annotation up
- Stub for rest of `@Cli` annotation page
- Stub for more In Practise pages
rvesse added a commit that referenced this issue Jan 18, 2016
@rvesse
Add help for the various help annotations (#35)
aa01a95 
- Documents all the help related annotations
- Updates navigation
rvesse added a commit that referenced this issue Jan 18, 2016
@rvesse
Start adding help for restriction annotations (#35)
3e0485e 
- Help for `@Required`
- Couple of minor fixes to other pages
rvesse added a commit that referenced this issue Jan 19, 2016
@rvesse
Minor tweaks based on User Guide work (#35)
9060ab0 
- More user guide examples
- Make ConvertResult public class so DefaultTypeConverter is more easily
  extended
rvesse added a commit that referenced this issue Jan 19, 2016
@rvesse
Add missing license headers (#35)
8142753
rvesse added a commit that referenced this issue Jan 19, 2016
@rvesse
Documentation for some restriction annotations (#35)
1ec3562 
- Document various requirement annotations
- Links for occurrences annotations
- Partially document @unrestricted annotation
rvesse added a commit that referenced this issue Jan 19, 2016
@rvesse
Add collapsible navigation (#35)
9fe59bd 
This commit adds the Multi-Level Pushdown Menu plugin to the website so
that the navigation is much more user friendly rather than a giant
unbounded list.  The menu will automatically expand to the level of the
page currently being viewed.
rvesse added a commit that referenced this issue Jan 19, 2016
@rvesse
Fix bug that can occur when resizing the window (#35)
01b3024 
Fixes a bug with the collapsible menu not resizing properly when the
window is resized
rvesse added a commit that referenced this issue Jan 19, 2016
@rvesse
Document occurrence restrictions (#35)
b52247b 
Adds documentation for the @once, @MinOccurrences and @MaxOccurrences
annotations.
rvesse added a commit that referenced this issue Jan 19, 2016
@rvesse
Add scripts for adding Javadoc to website (#35)
93ee883 
Adds scripts that can be used to quickly add the Javadoc for a specific
version to the website
rvesse added a commit that referenced this issue Jan 19, 2016
@rvesse
Add Javadoc to website (#35)
69aea39
rvesse added a commit that referenced this issue Jan 19, 2016
@rvesse
Add Javadoc to website (#35)
83121ec 
Adds the Javadoc to the website including a way to easily add links to
Javadoc for specific versions to the navigation menu
rvesse added a commit that referenced this issue Aug 23, 2018
@rvesse
More workshop slides (#35)
6a5b558
rvesse added a commit that referenced this issue Aug 31, 2018
@rvesse
Trying to finish up workshop (#35)
0fd87d1 
- Refine content for larger slide size
- Work on Parser section
rvesse added a commit that referenced this issue Aug 31, 2018
@rvesse
Trying to finish off slides (#35)
b542cd9 
- Cover HelpOption and Help command
- Reorg slides to put Help prior to parser customisation
- Add basics summary slide
rvesse added a commit that referenced this issue Aug 31, 2018
@rvesse
Almost finish workshop (#35)
484f075
rvesse added a commit that referenced this issue Aug 31, 2018
@rvesse
Minor polish and formatting (#35)
9e5bca0
rvesse added a commit that referenced this issue Sep 3, 2018
@rvesse
Add 2.6.0 javadoc (#35)
d0486e9
rvesse added a commit that referenced this issue Sep 3, 2018
@rvesse
Document resource locators (#35)
ca3ab5b
rvesse added a commit that referenced this issue Sep 3, 2018
@rvesse
Fix OS dependent paths example (#35)
f519da3
rvesse added a commit that referenced this issue Sep 3, 2018
@rvesse
Some minor docs clean up (#35)
d7c5df5
rvesse added a commit that referenced this issue Sep 3, 2018
@rvesse
Minor doc tweaks (#35)
0b1496b
rvesse added a commit that referenced this issue Sep 5, 2018
@rvesse
Finishing off slides (#35)
ccfbcba 
- Add Bash completion, Man page generation and Maven plugin usage
- Add plugin IT using the send-it example
rvesse added a commit that referenced this issue Sep 7, 2018
@rvesse
Hopefully final slide tweaks (#35)
bd48685 
Plus Windows version of send-it script
@rvesse rvesse added the user-experience Improves user experience label Sep 11, 2018
rvesse added a commit that referenced this issue Sep 11, 2018
@rvesse
Complete @cli documentation (#35)
3adfa52 
Also fixes a bug found while documenting new features of @parser
rvesse added a commit that referenced this issue Oct 22, 2018
@rvesse
Document new annotations (#73,#35)
54a3eec 
- @file and @Directory
- @startsWith and @ENDSWITH
rvesse added a commit that referenced this issue Oct 22, 2018
@rvesse
More new annotation docs (#73,#35)
a59bb7d 
- @positive and @Negative
- @ExactLength and @LengthRange
- Reorganise nav for restriction annotations to be clearer
rvesse added a commit that referenced this issue Oct 30, 2018
@rvesse
Further docs for @LengthRange (#73, #35)
c0956d7
rvesse added a commit that referenced this issue Nov 1, 2018
@rvesse
Stub out Maven plugin docs (#35, #45)
1befad3
rvesse added a commit that referenced this issue Nov 1, 2018
@rvesse
Continue documenting Maven plugin (#35, #45)
0eda2ae
rvesse added a commit that referenced this issue Nov 1, 2018
@rvesse
Further Maven plugin docs (#35, #45)
d90c2b2
rvesse added a commit that referenced this issue Nov 6, 2018
@rvesse
Complete first pass of Maven plugin docs (#35, #45)
16a4ae7
rvesse added a commit that referenced this issue Nov 20, 2018
@rvesse
Tweak Maven plugin docs (#35, #45)
53e26b9
@rvesse rvesse modified the milestones: Next Feature Release, 2.8.x Apr 26, 2019
@rvesse rvesse modified the milestones: 2.9.x, Unscheduled Feb 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@rvesse rvesse

Labels
documentation Documentation Changes enhancement Proposed Enhancement/Feature help Help System user-experience Improves user experience
Projects
None yet
Milestone
Unscheduled
Development

No branches or pull requests
1 participant
@rvesse