Skip to content
Permalink
Browse files
remove unneeded 'documentation' URI segment
  • Loading branch information
djencks committed Jul 19, 2021
1 parent dbd1caf commit 3782de8305fd32546630453cf1036617d4aa9986
Showing 112 changed files with 298 additions and 440 deletions.

Large diffs are not rendered by default.

@@ -4,85 +4,61 @@

indexList::[relative=*.adoc]
* Documentation
indexList::[level=2,relative=documentation/*.adoc]

** Community

indexList::[level=3,relative=documentation/community/*.adoc]
indexList::[level=3,relative=community/*.adoc]
** Development

indexList::[level=3,relative=documentation/development/*.adoc]
indexList::[level=3,relative=development/*.adoc]
** FAQS

indexList::[level=3,relative=documentation/faqs/*.adoc]
indexList::[level=3,relative=faqs/*.adoc]
** Subprojects

indexList::[level=3,relative=documentation/subprojects/*.adoc]
*** Commons (retired)

indexList::[level=4,relative=documentation/subprojects/apache-felix-commons/*.adoc]
indexList::[level=3,relative=subprojects/*.adoc]
*** Dependency Manager
**** Guides

indexList::[level=5,relative=documentation/subprojects/apache-felix-dependency-manager/guides/*.adoc]
indexList::[level=5,relative=subprojects/apache-felix-dependency-manager/guides/*.adoc]
**** Reference

indexList::[level=5,relative=documentation/subprojects/apache-felix-dependency-manager/reference/*.adoc]
indexList::[level=5,relative=subprojects/apache-felix-dependency-manager/reference/*.adoc]
**** Tutorials

indexList::[level=5,relative=documentation/subprojects/apache-felix-dependency-manager/tutorials/*.adoc]
indexList::[level=5,relative=subprojects/apache-felix-dependency-manager/tutorials/*.adoc]
*** Framework

indexList::[level=4,relative=documentation/subprojects/apache-felix-framework/*.adoc]
indexList::[level=4,relative=subprojects/apache-felix-framework/*.adoc]
*** GoGo Shell

indexList::[level=4,relative=documentation/subprojects/apache-felix-gogo/*.adoc]
*** iPOJO (retired)

indexList::[level=4,relative=documentation/subprojects/apache-felix-ipojo/**/*.adoc]
indexList::[level=4,relative=subprojects/apache-felix-gogo/*.adoc]
*** Maven SCR plugin

indexList::[level=4,relative=documentation/subprojects/apache-felix-maven-scr-plugin/*.adoc]
*** UPNP (retired)

indexList::[level=4,relative=documentation/subprojects/apache-felix-upnp/**/*.adoc]
*** User Admin (retired)

indexList::[level=4,relative=documentation/subprojects/apache-felix-user-admin/*.adoc]
indexList::[level=4,relative=subprojects/apache-felix-maven-scr-plugin/*.adoc]
*** Web Console

indexList::[level=4,relative=documentation/subprojects/apache-felix-web-console/*.adoc]
indexList::[level=4,relative=subprojects/apache-felix-web-console/*.adoc]
**** Extensions

indexList::[level=5,relative=documentation/subprojects/apache-felix-web-console/extending-the-apache-felix-web-console/*.adoc]
*** MOSGI (retired)

indexList::[level=4,relative=documentation/subprojects/mosgi-managed-osgi-framework/*.adoc]
indexList::[level=5,relative=subprojects/apache-felix-web-console/extending-the-apache-felix-web-console/*.adoc]
** Tutorials

indexList::[level=3,relative=documentation/tutorials-examples-and-presentations/*.adoc]
indexList::[level=3,relative=tutorials-examples-and-presentations/*.adoc]
*** OSGI Tutorial

indexList::[level=4,relative=documentation/tutorials-examples-and-presentations/apache-felix-osgi-tutorial/*.adoc]
indexList::[level=4,relative=tutorials-examples-and-presentations/apache-felix-osgi-tutorial/*.adoc]
//indexList::[]
File renamed without changes.
@@ -2,7 +2,7 @@

Apache Felix is a volunteer effort, so there is always plenty of work that needs to be accomplished.
If you want to help support Felix, this page is intended as a starting point for specific contribution ideas.
To further understand how the Felix community operates, refer to the https://www.apache.org/foundation/how-it-works.html[Community Roles and Processes] document and/or join the xref:documentation/community/project-info.adoc[mailing lists].
To further understand how the Felix community operates, refer to the https://www.apache.org/foundation/how-it-works.html[Community Roles and Processes] document and/or join the xref:community/project-info.adoc[mailing lists].

The Felix project organizes its "to do" list using the https://issues.apache.org/jira/browse/Felix[JIRA] issue tracking system.
Specific items from Felix' JIRA issue tracking system are highlighted on this page, but are not limited to it.
@@ -18,7 +18,7 @@ There is no specific JIRA issue for this task, but any contributions could be po

== Programmers

Before contributing, make sure to be subscribed to the xref:documentation/community/project-info.adoc[developer mailing list].
Before contributing, make sure to be subscribed to the xref:community/project-info.adoc[developer mailing list].
If you don't have your own issue to scratch, you can browse open issues in https://issues.apache.org/jira/browse/Felix[JIRA] and submit a patch.

Source code contributions fall into two categories: pull requests or grants.
@@ -48,7 +48,7 @@ For grants, you should:
+
[cols=2*]
|===
| Review our xref:documentation/development.adoc[developer documentation] as well as the general [Apache documentation
| Review our xref:development.adoc[developer documentation] as well as the general [Apache documentation
| https://www.apache.org/foundation/getinvolved.html] to determine whether you would really like be involved with us and how we work.
|===

File renamed without changes.
@@ -65,7 +65,7 @@ Everything else has been configured in the latest Felix parent POM:

First prepare your POMs for release:

. Make sure you have correct NOTICE, xref:documentation/development/dependencies-file-template.adoc[DEPENDENCIES], and LICENSE files.
. Make sure you have correct NOTICE, xref:development/dependencies-file-template.adoc[DEPENDENCIES], and LICENSE files.
Remember to update the copyright year.
. Make sure you have an updated change log file, typically in `doc/changelog.txt` but in the project root is also acceptable.
. Make sure there are no snapshots in the POMs to be released
@@ -2,18 +2,18 @@

In an effort to make it easier to find desired documentation, we have divided our documentation section into the following six areas:

* xref:documentation/getting-started.adoc[Getting started] - This area captures a few links from the areas below that will help you get started with Felix.
* xref:documentation/faqs.adoc[FAQs] - This area captures all FAQ documentation, which typically varies from subproject to subproject.
* xref:documentation/community.adoc[Community] - This area captures documentation associated with how the Felix community works and how to become involved in it.
* xref:documentation/development.adoc[Development] - This area captures documentation for Felix developers or those interested in becoming Felix developers;
* xref:getting-started.adoc[Getting started] - This area captures a few links from the areas below that will help you get started with Felix.
* xref:faqs.adoc[FAQs] - This area captures all FAQ documentation, which typically varies from subproject to subproject.
* xref:community.adoc[Community] - This area captures documentation associated with how the Felix community works and how to become involved in it.
* xref:development.adoc[Development] - This area captures documentation for Felix developers or those interested in becoming Felix developers;
this is not intended for Felix users although some information may be useful.
* xref:documentation/subprojects.adoc[Subprojects] - This area captures user documentation for the various Felix subprojects.
* xref:documentation/tutorials-examples-and-presentations.adoc[Tutorials, examples, and presentations] - This area captures general user documentation that does not necessarily fit into any single subproject.
* xref:subprojects.adoc[Subprojects] - This area captures user documentation for the various Felix subprojects.
* xref:tutorials-examples-and-presentations.adoc[Tutorials, examples, and presentations] - This area captures general user documentation that does not necessarily fit into any single subproject.
In addition a xref:auto-index.adoc[site map] is available as a table of contents of the site.

If you are unable to find the documentation you need, please ask on the xref:{{ refs.mailinglists.adoc[mailing lists].
If you are unable to find the documentation you need, please ask on the xref:mailinglists.adoc[mailing lists].
Also, feedback on improving the documentation and/or organization of this site is welcome.

_The Felix web site and documentation are managed with link:https://antora.org[Antora].
For Apache Felix specific information see the xref:documentation/development/site-how-to.adoc[Site How-To]._
For Apache Felix specific information see the xref:development/site-how-to.adoc[Site How-To]._

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

@@ -0,0 +1,6 @@
= Frequently Asked Questions

* xref:tutorials-examples-and-presentations/apache-felix-osgi-faq.adoc[OSGi FAQ] - Contains answers to general OSGi-related questions.
* xref:subprojects/apache-felix-framework/apache-felix-framework-faq.adoc[Framework FAQ] - Contains answers to questions that are specifically related to Felix' OSGi framework implementation.
* xref:faqs/apache-felix-bundle-plugin-faq.adoc[Bundle Plugin FAQ] - Contains answers to questions about the Felix maven-bundle-plugin
* xref:faqs/apache-felix-scr-plugin-faq.adoc[SCR Plugin FAQ] - Contains answers to questions about the Felix maven-scr-plugin
@@ -3,7 +3,7 @@


This page provides answers to frequently asked questions using the Maven SCR Plugin.
See xref:documentation/subprojects/apache-felix-maven-scr-plugin.adoc[] for documentation on that plugin.
See xref:subprojects/apache-felix-maven-scr-plugin.adoc[] for documentation on that plugin.

== Should I still use the Apache Felix SCR annotations over the official OSGi annotations?

0 comments on commit 3782de8

Please sign in to comment.