/docs/src/main/asciidoc/index.adoc

https://github.com/rachmatowicz/wildfly · AsciiDoc · 97 lines · 72 code · 25 blank · 0 comment · 0 complexity · c590195138ccabe0e011178d6cd7a103 MD5 · raw file

  1. [[index]]
  2. = WildFly Documentation
  3. :ext-relative: {outfilesuffix}
  4. ifdef::env-github[:imagesdir: images/]
  5. :toc!:
  6. image:splash_wildflylogo_small.png[WildFly, align="center"]
  7. Welcome to the WildFly Documentation. The documentation for WildFly is
  8. split into two categories:
  9. * _Administrator Guides_ for those wanting to understand how to install
  10. and configure the server
  11. * _Developer Guides_ for those wanting to understand how to develop
  12. applications for the server
  13. * _Model Reference_ the WildFly Model Reference provides information about all subsystem
  14. configuration options generated directly from the management model.
  15. [[administrator-guides]]
  16. == Administrator Guides
  17. * The link:Getting_Started_Guide{outfilesuffix}[Getting Started Guide] shows you
  18. how to install and start the server, how to configure logging, how to
  19. deploy an application, how to deploy a datasource, and how to get
  20. started using the command line interface and web management interface
  21. * The link:Admin_Guide{outfilesuffix}[Admin Guide] provides detailed information
  22. on using the CLI and Web Management interface, how to use the domain
  23. configuration, and shows you how to configure key subsystems
  24. * The link:High_Availability_Guide{outfilesuffix}[High Availability Guide] shows
  25. you how to create a cluster, how configure the web container and EJB
  26. container for clustering, and shows you how to configure load balancing
  27. and failover
  28. == Model Reference
  29. * The link:wildscribe[WildFly model reference^] provides information about all subsystem
  30. configuration options generated directly from the management model.
  31. [[developer-guides]]
  32. == Developer Guides
  33. * The link:Getting_Started_Developing_Applications_Guide{outfilesuffix}[Getting
  34. Started Developing Applications Guide] shows you how to build Java EE
  35. applications and deploy them to WildFly. The guide starts by showing you
  36. the simplest _helloworld_ application using just Servlet and CDI, and
  37. then adds in JSF, persistence and transactions, EJB, Bean Validation,
  38. RESTful web services and more. Finally, you'll get the opportunity to create
  39. your own skeleton project. Each tutorial is accompanied by a quickstart,
  40. which contains the source code, deployment descriptors and a Maven based
  41. build.
  42. * The link:Developer_Guide{outfilesuffix}[Developer Guide] ( _in progress_) takes
  43. you through every deployment descriptor and every annotation offered by
  44. WildFly.
  45. * The link:JavaEE_Tutorial{outfilesuffix}[JavaEE Tutorial] ( _in progress_)
  46. builds on what you learnt in the
  47. link:Getting_Started_Developing_Applications_Guide{outfilesuffix}[Getting Started
  48. Developing Applications Guide], and shows you how to build a complex
  49. application using Jakarta EE and portable extensions.
  50. * The link:Extending_WildFly{outfilesuffix}[Extending WildFly] guide walks you
  51. through creating a new WildFly subsystem extension, in order to add more
  52. functionality to WildFly, and shows how to test it before plugging it
  53. into WildFly.
  54. * The link:Testsuite{outfilesuffix}[WildFly Testsuite] guide walks you through testing WildFly
  55. == Security Guide
  56. * The link:WildFly_Elytron_Security{outfilesuffix}[WildFly Elytron Security] guide walks you through new security layer of of WildFly
  57. == Client Guide
  58. * The link:Client_Guide{outfilesuffix}[WildFly Client Configuration] guide walks you through new wildfly client and how to use it.
  59. [[quickstarts]]
  60. == Quickstarts
  61. WildFly comes with a number of quickstarts, examples which introduce to
  62. a particular technology or feature of the application server. The
  63. link:https://github.com/jboss-developer/jboss-developer-shared-resources/blob/master/guides/CONTRIBUTING.md#contribute-a-quickstart[Contributing a Quickstart] section
  64. of the documentation details the available quickstarts
  65. [[more-resources]]
  66. == More Resources
  67. * link:Glossary.html[Glossary]
  68. * http://www.wildfly.org[WildFly project page]
  69. * https://issues.redhat.com/browse/WFLY[WildFly issue tracker]
  70. * https://community.jboss.org/en/wildfly[WildFly user forum]
  71. * https://community.jboss.org/en/wildfly/dev[WildFly wiki]
  72. * https://github.com/wildfly/wildfly/[WildFly source]