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

Add base folder for plugin documentation #971

Merged
merged 6 commits into from Oct 17, 2016
Merged

Conversation

@six42
Copy link
Contributor

@six42 six42 commented Sep 12, 2016

This PR has additional documentation:

  1. Add base folder for plugin documentation as discussed in #685

  2. Add information about plugins and contacts to the standard page footer
    On fitnesse.org the information about plugins is eye catching. Once FitNesse is installed on your own system no eye catching link is provided.
    By adding a link to the footer this should advertise the plugins and hopefully more people will provide plugins.
    For new users of FitNesse it is also important that they don't feel left alone and have an easy way to get help. The contact link in the footer should do the job.

@amolenaar
Copy link
Collaborator

@amolenaar amolenaar commented Sep 17, 2016

I like the emphasis on plugins in the page footer.

How to make the plugins publish the documentation?

Loading

@six42
Copy link
Contributor Author

@six42 six42 commented Sep 17, 2016

Loading

six42 added 3 commits Sep 19, 2016
Add information about plugins and contacts to page footer
Add information about plugins and contacts to page footer
@@ -13,6 +13,7 @@
* [[Working with the FitNesse wiki][>FitNesseWiki]]
* [[Writing Acceptance Tests][>WritingAcceptanceTests]] (jump directly to [[Fit][>WritingAcceptanceTests.FitFramework]] or [[Slim][>WritingAcceptanceTests.SliM]])
* [[Administering FitNesse][>AdministeringFitNesse]]
* [[Extend Fitnesse with Plugins][.PlugIns]]
Copy link
Collaborator

@amolenaar amolenaar Oct 9, 2016

Choose a reason for hiding this comment

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

I don't think the name Extend FitNesse with Plugins covers it.

Maybe Installed plugins?

Loading

@@ -0,0 +1,16 @@
!1 Get more out of Fitnesse
Copy link
Collaborator

@amolenaar amolenaar Oct 9, 2016

Choose a reason for hiding this comment

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

FitNesse should be spelled "FitNesse". (there are some other typos like that)

Loading

Read [[Writing Plugins][FitNesse.UserGuide.AdministeringFitNesse.WritingPlugins]] to understand how to install them or write your ownn.


Below is the list of all installed plugins in this system:
Copy link
Collaborator

@amolenaar amolenaar Oct 9, 2016

Choose a reason for hiding this comment

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

That is: the plugins that have provided documentation ;).

Loading

Copy link
Contributor Author

@six42 six42 Oct 15, 2016

Choose a reason for hiding this comment

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

So true.
The hope is that once we have a common place for documentation defined that each plugin developer will add something.
Last but not least you can control it and not allow a plugin to be added to FitNesse.org which has no documentation at this place.

Loading

[[Front Page][.FrontPage]] | [[User Guide][.FitNesse.UserGuide]] | [[root][root]] (for global !-!path's-!, ''etc.'') | Press '?' for keyboard shortcuts | [[Extend Fitnesse with Plugins][.PlugIns]] | [[Contact][http://fitnesse.org/StayInformed]] | [[(edit)][.PageFooter?edit]]
Copy link
Collaborator

@amolenaar amolenaar Oct 9, 2016

Choose a reason for hiding this comment

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

Change to Installed plugins or something similar.

Loading

@amolenaar
Copy link
Collaborator

@amolenaar amolenaar commented Oct 9, 2016

I'm doing some Sunday morning nit picking ;). There's no feature available that installs plugins once the big "FitNesse update documentation" thingy has run. I think that's okay. This is nice and simple and it provides an easy to use convention.

Thank you :)

Loading

@amolenaar amolenaar added this to the Next Release milestone Oct 9, 2016
@six42
Copy link
Contributor Author

@six42 six42 commented Oct 15, 2016

all updated

Loading

@amolenaar amolenaar merged commit 95de236 into unclebob:master Oct 17, 2016
amolenaar added a commit that referenced this issue Oct 17, 2016
Add base folder for plugin documentation
@amolenaar
Copy link
Collaborator

@amolenaar amolenaar commented Oct 17, 2016

It's in :)

Loading

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants