Skip to content

ISPN-10015 revamping documentation layout #72

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

Merged
merged 1 commit into from
Jul 15, 2019
Merged

ISPN-10015 revamping documentation layout #72

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 20 additions & 4 deletions _config/ispn.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,14 +49,30 @@ unstable:
as7modules: https://downloads.jboss.org/infinispan/10.0.0.Beta3/infinispan-wildfly-modules-10.0.0.Beta3.zip
docs:
home: /docs/dev/index.html
user_guide: /docs/dev/user_guide/user_guide.html
server_guide: /docs/dev/server_guide/server_guide.html
getting_started_guide: /docs/dev/getting_started/getting_started.html
faqs: /docs/dev/faqs/faqs.html
javadocs: https://docs.jboss.org/infinispan/10.0/apidocs/
configdocs: https://docs.jboss.org/infinispan/10.0/configdocs/
jmxdocs: https://docs.jboss.org/infinispan/10.0/apidocs/jmxComponents.html

# Documentation titles
titles:
clustering: /docs/dev/titles/clustering/clustering.html
configuring: /docs/dev/titles/configuring/configuring.html
contributing: /docs/dev/titles/contributing/contributing.html
developing: /docs/dev/titles/developing/developing.html
embedding: /docs/dev/titles/embedding/embedding.html
extending: /docs/dev/titles/extending/extending.html
getting_started: /docs/dev/titles/getting_started/getting_started.html
hr_protocol: /docs/dev/titles/hotrod_protocol/hotrod_protocol.html
integrating: /docs/dev/titles/integrating/integrating.html
indexing_querying: /docs/dev/titles/querying/querying.html
managing: /docs/dev/titles/managing/managing.html
monitoring: /docs/dev/titles/monitoring/monitoring.html
security: /docs/dev/titles/security/security.html
server: /docs/dev/titles/server/server.html
tech_overview: /docs/dev/titles/overview/overview.html
tuning: /docs/dev/titles/tuning/tuning.html
xsite: /docs/dev/titles/xsite/xsite.html

# Older releases
## Leaving out the docs: element means that docs won't be displayed for this version.
## Leaving out any section of the docs, e.g., the user guide, will mean that the latest version will be used.
Expand Down
2 changes: 1 addition & 1 deletion _partials/nav.html.haml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,5 +61,5 @@
%li<
%a(href="/getinvolved") Get Involved
%li{:class=>"#{'active' if page.output_path.start_with?('/roadmap') }" }<
%a(href="/roadmap") Road Map
%a(href="/roadmap") Road Map
%li.divider
42 changes: 42 additions & 0 deletions _partials/rightcol-doc-versions.html.haml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
%h3 Documentation versions

%hr

- if site.ispn.has_key?("unstable")
.text-warning
%i.icon-wrench
Development (Infinispan #{site.ispn.unstable.minor_version})
%span.caret

%ul.nav.nav-pills.nav-stacked
%li
%a{:href =>site.ispn.unstable.docs.home} Index
%li
%a{:href=>site.ispn.unstable.docs.javadocs} Javadocs
%li
%a{:href=>site.ispn.unstable.docs.configdocs} Configuration Schema
%li
%a{:href=>site.ispn.unstable.docs.jmxdocs} JMX Reference

%hr

- if site.ispn.has_key?("stable")
.text-success
%i.icon-ok-circle
Stable (Infinispan #{site.ispn.stable.minor_version})
%span.caret

%ul.nav.nav-pills.nav-stacked
%li
%a{:href=>site.ispn.stable.docs.home} Index
%li
%a{:href=>site.ispn.stable.docs.javadocs} Javadocs
%li
%a{:href=>site.ispn.stable.docs.configdocs} Configuration Schema
%li
%a{:href=>site.ispn.stable.docs.jmxdocs} JMX Reference

%hr

%i.icon-book
%a(href="/books") Find documentation for older versions of Infinispan.
44 changes: 44 additions & 0 deletions books.html.haml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
layout: project
title: Books
---
%h2 Documentation for Older Versions of Infinispan

%hr
%p Welcome to the collection of books and documentation for older versions of Infinispan.

%table.table.table-bordered.table-striped
%thead
%tr
%th{:width => "15%", :style => "width: 15%;"} Version
%th
%th
%th
%th
%th
%th
%tbody
- site.ispn.old.each do |ver, cfg|
- doc = cfg.docs
- minor_version = cfg.minor_version
%tr
%td
#{minor_version}
%td
- if doc.has_key?("javadocs")
%a{:href=>doc.javadocs} Javadocs
%td
- if doc.has_key?("configdocs")
%a{:href=>doc.configdocs} Configuration Schema
%td
- if doc.has_key?("jmxdocs")
%a{:href=>doc.jmxdocs} JMX Reference
%td
- if doc.has_key?("user_guide")
%a{:href=>doc.user_guide} User Guide
%td
- if doc.has_key?("server_guide")
%a{:href=>doc.server_guide} Server Guide
%td
- if doc.has_key?("getting_started_guide")
%a{:href=>doc.getting_started_guide} Getting Started
215 changes: 86 additions & 129 deletions documentation.html.haml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,136 +1,93 @@
---
layout: project
layout: rightcol
rightcol_partial: rightcol-doc-versions.html.haml
title: Documentation
---
%h2 Infinispan community documentation
%p Welcome to the Infinispan documentation, straight from the source! Here you can find help and knowledge provided by the community of contributors.

%ul.nav.nav-pills
%li.active
%a{"data-toggle" => "pill", :href => "#start"} Getting Started
%li
%a{"data-toggle" => "pill", :href => "#config"} Configuring
%li
%a{"data-toggle" => "pill", :href => "#code"} Developing
%li
%a{"data-toggle" => "pill", :href => "#deploy"} Running
%li
%a{"data-toggle" => "pill", :href => "#monitor"} Monitoring
.tab-content
#start.tab-pane.fade.in.active
%ul.list-group
%li.list-group-item
%a{:href => site.ispn.titles.getting_started} Get Started with Infinispan
%p Dive in to quickly learn the basics.
%li.list-group-item
%a{:href => site.ispn.titles.tech_overview} Technical Overview
%p Find out about Infinispan architecture and capabilities.
%li.list-group-item
%a(href="/release-notes/") Release Notes
%p Review version information.
#config.tab-pane.fade
%ul.list-group
%li.list-group-item
%a{:href => site.ispn.titles.configuring} Configuring Infinispan
%p Tailor Infinispan to your needs, from straightforward caching to complex, geographically-distributed data grids.
%li.list-group-item
%a{:href => site.ispn.titles.managing} Managing Data in the Grid
%p Configure Infinispan to manage data with eviction and expiration and persist data with cache stores.
%li.list-group-item
%a{:href => site.ispn.titles.extending} Extending Infinispan
%p Use custom configurations, operations, and components with Infinispan.
#code.tab-pane.fade
%ul.list-group
%li.list-group-item
%a{:href => site.ispn.titles.embedding} Embedding Infinispan
%p Run Infinispan as a library within your application.
%li.list-group-item
%a{:href => site.ispn.titles.developing} Programming with Infinispan
%p Develop custom applications that use Infinispan APIs to read, write, encode, serialize, and manipulate data in the grid.
%li.list-group-item
%a{:href => site.ispn.titles.integrating} Integrating Infinispan
%p Use Infinispan with other projects and technologies such as Spring Framework, Apache Lucene, and Hibernate Cache.
%li.list-group-item
%a{:href => site.ispn.titles.indexing_querying} Indexing and Querying
%p Index and query objects in the grid using Infinispan's annotation and search capabilities.
%li.list-group-item
%a{:href => site.ispn.titles.hr_protocol} Hot Rod Protocol Reference
%p Get details about different versions of the Hot Rod protocol.
#deploy.tab-pane.fade
%ul.list-group
%li.list-group-item
%a{:href => site.ispn.titles.server} Deploying Infinispan in Server Mode
%p Set up Infinispan servers on bare-metal to provide remote client access.
%li.list-group-item
%a{:href => site.ispn.titles.clustering} Creating Infinispan Clusters
%p Join Infinispan nodes to distribute and replicate data.
%li.list-group-item
%a{:href => site.ispn.titles.xsite} Setting Up Cross Site Replication
%p Back up across multiple data centers quickly and reliably.
%li.list-group-item
%a{:href => site.ispn.titles.security} Security Guide
%p Review security best practices and considerations.
#monitor.tab-pane.fade
%ul.list-group
%li.list-group-item
%a{:href => site.ispn.titles.monitoring} Monitoring and Administration
%p Learn how to monitor Infinispan and perform administrative tasks.
%li.list-group-item
%a{:href => site.ispn.titles.tuning} Tuning Performance
%p Optimize JVM settings, memory resources, and network configuration.

.jumbotron
%h2 Documentation
%p The official Infinispan documentation, straight from the source!
%table.table.table-bordered.table-striped
%thead
%tr
%th{:width => "15%", :style => "width: 15%;"} Version
%th
%th
%th
%th
%th
%th
%th
%th
%tbody
- if site.ispn.has_key?("unstable")
%tr
%td
#{site.ispn.unstable.minor_version}
.label.label-warning.pull-right
%i.icon-warning-sign
Unstable
%td
%a{:href=>site.ispn.unstable.docs.home} All docs
%td
%a{:href=>site.ispn.unstable.docs.user_guide} User Guide
%td
%a{:href=>site.ispn.unstable.docs.server_guide} Server Guide
%td
%a{:href=>site.ispn.unstable.docs.getting_started_guide} Getting Started
%td
%a{:href=>site.ispn.unstable.docs.faqs} FAQs
%td
%a{:href=>site.ispn.unstable.docs.javadocs} Javadocs
%td
%a{:href=>site.ispn.unstable.docs.configdocs} Configuration Schema
%td
%a{:href=>site.ispn.unstable.docs.jmxdocs} JMX Reference
%tr
%td
#{site.ispn.stable.minor_version}
.label.label-success.pull-right
%i.icon-check-sign
Stable
%td
%a{:href=>site.ispn.stable.docs.home} All docs
%td
%a{:href=>site.ispn.stable.docs.user_guide} User Guide
%td
%a{:href=>site.ispn.stable.docs.server_guide} Server Guide
%td
%a{:href=>site.ispn.stable.docs.getting_started_guide} Getting Started
%td
%a{:href=>site.ispn.stable.docs.faqs} FAQs
%td
%a{:href=>site.ispn.stable.docs.javadocs} Javadocs
%td
%a{:href=>site.ispn.stable.docs.configdocs} Configuration Schema
%td
%a{:href=>site.ispn.stable.docs.jmxdocs} JMX Reference
%i
For versions prior to 5.3.x, please refer to the
%b 5.3.x documentation.
%p Javadocs for all versions are available online.
%h3 Join us
%p Infinispan is actively developed and maintained by a community of generally cool people. We welcome you to chat with us, report issues, suggest changes, or ask questions.
%i.icon-comments-alt
%a(href="/community") Join the Infinispan community!

%table.table.table-bordered.table-striped
%thead
%tr
%th{:width => "15%", :style => "width: 15%;"} Version
%th
%th
%th
%th
%th
%th
%th
%th
%tbody
- site.ispn.old.each do |ver, cfg|
- doc = cfg.docs
- minor_version = cfg.minor_version
%tr
%td
#{minor_version}
%td
- if doc.has_key?("home")
%a{:href=>doc.home} All docs
%td
- if doc.has_key?("user_guide")
%a{:href=>doc.user_guide} User Guide
%td
- if doc.has_key?("server_guide")
%a{:href=>doc.server_guide} Server Guide
%td
- if doc.has_key?("getting_started_guide")
%a{:href=>doc.getting_started_guide} Getting Started
%td
- if doc.has_key?("faqs")
%a{:href=>doc.faqs} FAQs
%td
- if doc.has_key?("javadocs")
%a{:href=>doc.javadocs} Javadocs
%td
- if doc.has_key?("configdocs")
%a{:href=>doc.configdocs} Configuration Schema
%td
- if doc.has_key?("jmxdocs")
%a{:href=>doc.jmxdocs} JMX Reference
%h3 Contribute to Infinispan
%p Got an improvement to the source code or want to write some docs?
%i.icon-github
%a{:href => site.ispn.titles.contributing} Review the Contributer's Guide and submit a PR.



%hr
%h2 Community Help
%p Infinispan is backed by an active community of developers, end users, content producers and generally cool people. :)
%dl.dl-horizontal
%dt
%i.icon-bookmark
User Forums
%dd can help answer questions you have and be a point of discussion and reference for using Infinispan
%dt
%i.icon-comments-alt
IRC
%dd
is our real-time chat location. Join us on the
%code #infinispan
IRC channel on
%a{:href=>"http://freenode.net/", :target=>"_new"}Freenode.
Join in to talk to us in real time!
%a.btn{:href => "/community", :role => "button"} Talk to us
~ content