View Source

*Translations:*\\ [Japanese|GlassFishUserFAQJa]\\ [Italian|FaqContributeToUserFAQIt]\\ [Russian|FaqContributeToUserFAQRu]\\ [Simplified Chinese|FaqContributeToUserFAQZh]\\ [Spanish|FaqContributeToUserFAQEs]


h2. How do I contribute to this User FAQ?
Contributions of all kinds are welcomed and encouraged. Those contributions will certainly be appreciated the next time you or someone else is struggling with the question, "How do I ...?".

To add new FAQs or edit existing ones you must first have an account. Click Log In at the top of the page to register if necessary.

If you have questions or suggestions about this FAQ, please contact [docs@glassfish.dev.java.net|^mailto:docs@glassfish.dev.java.net]. You can subscribe to the alias from the GlassFish [mailing lists|https://glassfish.dev.java.net/servlets/ProjectMailingListList] page.

*Suggested ways to contribute*

** Post the answer to an existing question for which an answer is needed* (questions listed in the [User FAQ Wish List|GlassFishUserFAQ#UserFAQWishList] section on the main FAQ page). Maybe you've struggled with the same problem and finally figured it out. Maybe you've blogged about the subject or answered the same question when it's come up over and over again in one of the forums. If you have expertise to share, please do so.

** Post a new question for which you also have the answer.* First make sure the FAQ doesn't already exist (if it does, see the point below). Then ask yourself if this is really a frequently asked question. Is it something that's been asked and answered many times on mailing lists? Is it something many people (especially new users!) are likely to ask about and need help with? If so, add it.

** Add more information to an FAQ written by someone else.* If you've got something to add that will improve an existing FAQ, please do so. Maybe that's a detailed example (examples are good!), a workaround that worked for you late one night when nothing else did, or a cool tip that people should know about.

*FAQ format*

FAQ entries should use the same naming convention and follow the same format. This is really important. Please do the following:

** Use the Faq prefix when naming a wiki page*, and make the rest of the name short but descriptive. For instance, the name of this page is _FaqContributeToUserFAQ_.

** Add new FAQs in the appropriate category.* If you don't see the category on the main [GlassFish User FAQ|GlassFishUserFAQ] page, add it. You must also add a corresponding entry to the Table of Contents on the main page so people can easily find what you've added. Follow the format of the other entries on the main page.

** Repeat your question as a heading on the answer page, and make sure the question matches what's listed on the main User FAQ page.* For instance, the question _How do I contribute to this User FAQ?_ is listed on both the main [GlassFish User FAQ|GlassFishUserFAQ] page and at the top of this answer page. One example of a mismatch that would need correcting is the question _How do I contribute to this User FAQ?_ and the answer _Contributing to this FAQ_.

** If possible, and if it makes sense to do so, include a version number in your heading.* This helps people know to which version of GlassFish the FAQ applies (v2, v3 Prelude, and so on).

** Use a medium-sized heading for the question at the start of your answer* (!! markup). For instance, _How do I contribute to this User FAQ?_ at the top of this page has slightly larger text and a different color. That was accomplished by using !! heading markup.

** Follow a few simple editorial guidelines.* The name _GlassFish_ has an *uppercase F*. For example, *GlassFish* instead of Glassfish. The version number is referred to with a *lowercase v*. For example, *v2* or *v3* instead of V2 or V3. Also use the *lowercase v* instead of the full word _version_. For example, use *v3* instead of _version 3_. This usage is clearly not consistent on the wiki but should be followed when adding new content. For more editorial guidelines, see the [GlassFish v3 Documentation Style Sheet|GlassFishV3DocStyleSheet].

*FAQ content guidelines*

** Follow the format guidelines listed above.* Consistency is important.

** Make sure the FAQ is user-focused rather than developer-focused*, geared toward the users of GlassFish rather than the developers of GlassFish. For developer-related questions, go to the [GlassFish Developer FAQ|GlassFishDeveloperFAQ].

** Make your FAQ title a real question that someone would actually ask.* It should be short and to the point, ideally not longer than one line and providing a concise summary of what the topic is about.

*To add new FAQs*
# Click Log In at the top of the page and authenticate. You'll need to register for an account if you don't have one. See [How do I register?|FaqWikiLogIn] for more information about registration.
# Click GlassFish User FAQ on the left if you're not already on this page. The GlassFishUserFAQ page is displayed.
# Click Edit at the bottom of the page. This Edit option is not available unless you're logged in. See [Why can't I edit a GlassFish Wiki page?|FaqWikiCannotEdit] if you're logged in and this Edit option is not available.
# Scroll to the appropriate category (such as _Installation_) and add your question to the list, following the format used for other questions and paying attention to the guidelines listed above. If you don't see a category that fits, create one. *Important*: If you add a new category you must also add a corresponding entry in the Table of Contents. Follow the same format used for other entries.
# Preview your entries, modify if necessary, then save.
# Click your question in the list on the GlassFishUserFAQ page and add content to the resulting topic page.
# Preview your content, modify if necessary, then save.

*To edit existing FAQs*
# Click Log In at the top of the page and authenticate. You'll need to register for an account if you don't have one. See [How do I register?|FaqWikiLogIn] for more information about registration.
# Click GlassFish User FAQ on the left if you're not already on this page. The GlassFishUserFAQ page is displayed.
# Click the link for the FAQ you want to edit. The topic page is displayed.
# Click Edit at the bottom of the page. This Edit option is not available unless you're logged in. See [Why can't I edit a GlassFish Wiki page?|FaqWikiCannotEdit] if you're logged in and this Edit option is not available.
# Edit the content on the page that displays.
# Preview your changes, modify if necessary, then save.

----
{color:purple}Old URL (read-only): [http://wiki.glassfish.java.net/Wiki.jsp?page=FaqContributeToUserFAQ]{color}
{color:blue}New Page: [https://wikis.sun.com/display/glassfishwiki/FaqContributeToUserFAQ]{color}