Skip to content
Permalink
Browse files
change most link: to xref:
  • Loading branch information
djencks committed May 11, 2021
1 parent 356d91e commit 9f25791e2ce8cce39dad9ad98bbb25fb2c1d919e
Showing 70 changed files with 323 additions and 320 deletions.
@@ -2,18 +2,18 @@ Title: Documentation

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

* link:{{ refs.getting-started.path }}[Getting started] - This area captures a few links from the areas below that will help you get started with Felix.
* link:{{ refs.faqs.path }}[FAQs] - This area captures all FAQ documentation, which typically varies from subproject to subproject.
* link:{{ refs.community.path }}[Community] - This area captures documentation associated with how the Felix community works and how to become involved in it.
* link:{{ refs.development.path }}[Development] - This area captures documentation for Felix developers or those interested in becoming Felix developers;
* 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;
this is not intended for Felix users although some information may be useful.
* link:{{ refs.subprojects.path }}[Subprojects] - This area captures user documentation for the various Felix subprojects.
* link:{{ refs.tutorials-examples-and-presentations.path }}[Tutorials, examples, and presentations] - This area captures general user documentation that does not necessarily fit into any single subproject.
* 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.
In addition a https://felix.apache.org/sitemap.html[site map] is available as a table of contents of the site.
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 link:{{ refs.mailinglists.path }}[mailing lists].
If you are unable to find the documentation you need, please ask on the xref:{{ refs.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 the https://www.apache.org/dev/cms.html[Apache CMS].
For Apache Felix specific extensions see the link:{{refs.site-how-to.path}}[Site How-To]._
_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]._
@@ -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 link:{{ refs.project-info.path }}[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:documentation/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 link:{{ refs.project-info.path }}[developer mailing list].
Before contributing, make sure to be subscribed to the xref:documentation/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.
@@ -31,7 +31,7 @@ If you have created a change, you should:

. Create a https://issues.apache.org/jira/browse/Felix[JIRA] issue (or find a pertinent existing issue) describing the issue needing to be addressed.
. Create a pull requests against the git repository containing the code.
. The pull request will eventually be reviewed and applied (if accepted) by a Felix committer, but feel free to bug us [nicely]({{ refs.nicely.path }}) if you get impatient.
. The pull request will eventually be reviewed and applied (if accepted) by a Felix committer, but feel free to bug us [nicely]({{ refs.nicely.adoc) if you get impatient.

Providing pull requests is a very good way to become a committer at Felix, since we'd rather have you review and apply the patches than us.
:-)
@@ -48,7 +48,7 @@ For grants, you should:
+
[cols=2*]
|===
| Review our link:{{ refs.development.path }}[developer documentation] as well as the general [Apache documentation
| Review our xref:documentation/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.
|===

@@ -67,7 +67,7 @@ Everything else has been configured in the latest Felix parent POM:

First prepare your POMs for release:

. Make sure you have correct NOTICE, link:{{ refs.dependencies-file-template.path }}[DEPENDENCIES], and LICENSE files.
. Make sure you have correct NOTICE, xref:documentation/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
@@ -252,6 +252,9 @@ To do this, execute the following command in a checkout of the release tag (targ
-DaltDeploymentRepository=apache.website::default::file:///${obr}
$ svn commit -m"..." ${obr}/repository.xml


WARNING: the following about the site is wrong and needs to be rewritten

After committing the site must be published.
If you release to OBR before link:update-the-site[updating the site] you can defer publishing until after that.
Otherwise publish the site by visiting the https://cms.apache.org/felix/publish[Site Publication] link.
@@ -1,5 +1,7 @@
= Site How To

WARNING: This page is totaly wrong and needs to be rewritten.

The site is managed with the https://www.apache.org/dev/cms.html[Apache CMS] where the source is kept in SVN at https://svn.apache.org/repos/asf/felix/site/trunk/content.

== To update the documentation using the CMS system
@@ -1,6 +1,6 @@
= Frequently Asked Questions

* link:{{ refs.apache-felix-osgi-faq.path }}[OSGi FAQ] - Contains answers to general OSGi-related questions.
* link:{{ refs.apache-felix-framework-faq.path }}[Framework FAQ] - Contains answers to questions that are specifically related to Felix' OSGi framework implementation.
* link:{{ refs.apache-felix-bundle-plugin-faq.path }}[Bundle Plugin FAQ] - Contains answers to questions about the Felix maven-bundle-plugin
* link:{{ refs.apache-felix-scr-plugin-faq.path }}[SCR Plugin FAQ] - Contains answers to questions about the Felix maven-scr-plugin
* xref:documentation/tutorials-examples-and-presentations/apache-felix-osgi-faq.adoc[OSGi FAQ] - Contains answers to general OSGi-related questions.
* xref:documentation/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:documentation/faqs/apache-felix-bundle-plugin-faq.adoc[Bundle Plugin FAQ] - Contains answers to questions about the Felix maven-bundle-plugin
* xref:documentation/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 link:{{ refs.apache-felix-maven-scr-plugin.path }}[{{ refs.apache-felix-maven-scr-plugin.headers.title }}] for documentation on that plugin.
See xref:documentation/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?

@@ -3,10 +3,10 @@
For first-time users, here are a few links that might get you started more quickly:

* https://felix.apache.org/downloads.cgi[Downloads] - Go to the download page and download and extract the Felix release.
* link:{{ refs.apache-felix-framework-usage-documentation.path }}[Launching Felix] - Go to the Felix usage page to learn how to launch the Felix framework.
* link:{{ refs.apache-felix-osgi-tutorial.path }}[OSGi tutorial] - Go to the tutorial page to learn some OSGi basics.
* link:{{ refs.apache-felix-osgi-faq.path }}[OSGi FAQ] - Check out the OSGi FAQ for answers to common questions.
* link:{{ refs.documentation.path }}[Documentation] - Search the documentation pages for additional examples and presentations or subproject documentation to learn about specific subprojects.
* xref:documentation/subprojects/apache-felix-framework/apache-felix-framework-usage-documentation.adoc[Launching Felix] - Go to the Felix usage page to learn how to launch the Felix framework.
* xref:documentation/tutorials-examples-and-presentations/apache-felix-osgi-tutorial.adoc[OSGi tutorial] - Go to the tutorial page to learn some OSGi basics.
* xref:documentation/tutorials-examples-and-presentations/apache-felix-osgi-faq.adoc[OSGi FAQ] - Check out the OSGi FAQ for answers to common questions.
* xref:documentation.adoc[Documentation] - Search the documentation pages for additional examples and presentations or subproject documentation to learn about specific subprojects.
If you are unable to find the documentation you need, please ask on the link:{{ refs.mailinglists.path }}[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.
@@ -28,87 +28,87 @@ If this project is not using Maven, refer to the docs for the subproject on how
| An implementation of the https://osgi.org/specification/osgi.cmpn/7.0.0/service.cm.html[OSGi Configuration Admin service specification] for managing bundle configuration properties.
| https://github.com/apache/felix-dev/tree/master/configadmin[source]

| link:subprojects/apache-felix-dependency-manager.html[Dependency Manager]
| xref:documentation/subprojects/apache-felix-dependency-manager.adoc[Dependency Manager]
| An API-based component model to simplify OSGi-based development.
| https://github.com/apache/felix-dev/tree/master/dependencymanager[source]

| link:subprojects/apache-felix-event-admin.html[Event Admin]
| xref:documentation/subprojects/apache-felix-event-admin.adoc[Event Admin]
| An implementation of the OSGi Event Admin service specification for event-based communication.
| https://github.com/apache/felix-dev/tree/master/eventadmin[source]

| link:subprojects/apache-felix-file-install.html[File Install]
| xref:documentation/subprojects/apache-felix-file-install.adoc[File Install]
| A simple, directory-based management agent for managing bundle deployment.
| https://github.com/apache/felix-dev/tree/master/fileinstall[source]

| link:subprojects/apache-felix-framework.html[Framework]
| xref:documentation/subprojects/apache-felix-framework.adoc[Framework]
| An implementation of the OSGi R7 core framework.
| https://github.com/apache/felix-dev/tree/master/framework[source]

| link:subprojects/apache-felix-framework-security.html[Framework Security]
| xref:documentation/subprojects/apache-felix-framework-security.adoc[Framework Security]
|
| https://github.com/apache/felix-dev/tree/master/framework.security[source]

| link:subprojects/apache-felix-gogo.html[Gogo]
| xref:documentation/subprojects/apache-felix-gogo.adoc[Gogo]
| An advanced shell for interacting with OSGi frameworks.
| https://github.com/apache/felix-dev/tree/master/gogo[source]

| link:subprojects/apache-felix-healthchecks.html[Health Checks]
| xref:documentation/subprojects/apache-felix-healthchecks.adoc[Health Checks]
| An extensible framework to monitor the status of the OSGi container at runtime.
| https://github.com/apache/felix-dev/tree/master/healthcheck[source]

| https://github.com/apache/felix-dev/tree/master/http[HTTP Service]
| An implementation of the https://osgi.org/specification/osgi.cmpn/7.0.0/service.http.whiteboard.html[OSGi HTTP Whiteboard] and https://osgi.org/specification/osgi.cmpn/7.0.0/service.http.html[Http Service specification].
| https://github.com/apache/felix-dev/tree/master/http[source]

| link:subprojects/apache-felix-inventory.html[Inventory Printer]
| xref:documentation/subprojects/apache-felix-inventory.adoc[Inventory Printer]
| A simple and extensible framework to retrieve inventory information about applications running in an OSGi Framework.
| https://github.com/apache/felix-dev/tree/master/inventory[source]

| link:subprojects/apache-felix-ipojo.html[iPOJO]
| xref:documentation/subprojects/apache-felix-ipojo.adoc[iPOJO]
| A sophisticated service-oriented component model to simplify OSGi-based development.
| https://github.com/apache/felix-dev/tree/master/ipojo[source]

| link:subprojects/apache-felix-log.html[Log]
| xref:documentation/subprojects/apache-felix-log.adoc[Log]
| A simple, memory-based implementation of the OSGi Log service specification.
| https://github.com/apache/felix-dev/tree/master/log[source]

| link:subprojects/apache-felix-logback.html[Logback]
| xref:documentation/subprojects/apache-felix-logback.adoc[Logback]
| Apache Felix Logback is a small integration of the https://logback.qos.ch/[Logback] backend with OSGi.
| https://github.com/apache/felix-dev/tree/master/logback[source]

| link:subprojects/apache-felix-maven-bundle-plugin-bnd.html[Maven Bundle Plugin]
| xref:documentation/subprojects/apache-felix-maven-bundle-plugin-bnd.adoc[Maven Bundle Plugin]
| A Maven plugin to simplify building bundles.
| https://github.com/apache/felix-dev/tree/master/tools/maven-bundle-plugin[source]

| link:subprojects/apache-felix-metatype-service.html[Metatype]
| xref:documentation/subprojects/apache-felix-metatype-service.adoc[Metatype]
| An implementation of the OSGi Metatype service to describe types needed by bundles.
| https://github.com/apache/felix-dev/tree/master/shell[source]

| link:subprojects/apache-felix-osgi-bundle-repository.html[OSGi Bundle Repository]
| xref:documentation/subprojects/apache-felix-osgi-bundle-repository.adoc[OSGi Bundle Repository]
| A bundle repository service to simplify discovering and deploying bundles and their dependencies.
| https://github.com/apache/felix-dev/tree/master/org.osgi.service.obr[source]

| link:subprojects/apache-felix-preferences-service.html[Preferences Service]
| xref:documentation/subprojects/apache-felix-preferences-service.adoc[Preferences Service]
| An implementation of the OSGi Preferences service specification for storing settings and preferences.
| https://github.com/apache/felix-dev/tree/master/preferences[source]

| link:subprojects/apache-felix-remote-shell.html[Remote Shell]
| xref:documentation/subprojects/apache-felix-remote-shell.adoc[Remote Shell]
| A remote, text-based interface to the Apache Felix Shell.
| https://github.com/apache/felix-dev/tree/master/shell.remote[source]

| https://github.com/apache/felix-dev/tree/master/scr[Service Component Runtime]
| An implementation of the https://osgi.org/specification/osgi.cmpn/7.0.0/service.component.html[OSGi Declarative Services specification] providing a service-oriented component model to simplify OSGi-based development.
| https://github.com/apache/felix-dev/tree/master/scr[source]

| link:subprojects/apache-felix-shell.html[Shell]
| xref:documentation/subprojects/apache-felix-shell.adoc[Shell]
| A very simple shell service implemented as a bundle for interacting with an OSGi framework instance.
| https://github.com/apache/felix-dev/tree/master/shell[source]

| link:subprojects/apache-felix-shell-tui.html[Shell TUI]
| xref:documentation/subprojects/apache-felix-shell-tui.adoc[Shell TUI]
| A simple, text-based interface to the Apache Felix Shell.
| https://github.com/apache/felix-dev/tree/master/shell.tui[source]

| link:subprojects/apache-felix-web-console.html[Web Console]
| xref:documentation/subprojects/apache-felix-web-console.adoc[Web Console]
| A simple tool to inspect and manage OSGi framework instances using your favorite Web Browser.
| https://github.com/apache/felix-dev/tree/master/webconsole[source]
|===
@@ -117,18 +117,18 @@ If this project is not using Maven, refer to the docs for the subproject on how

The following projects are in maintenance mode meaning there is no active development anymore.

* link:subprojects/apache-felix-autoconf.html[Auto Configuration]
* link:subprojects/apache-felix-commons.html[Commons]
* link:subprojects/apache-felix-deployment-admin.html[Deployment Admin]
* link:subprojects/apache-felix-jaas.html[JAAS Support]
* link:subprojects/apache-felix-lightweight-http-service.html[Lightweight HTTP Service]
* link:subprojects/apache-felix-manifest-generator-mangen.html[Manifest Generator (mangen)]
* link:subprojects/apache-felix-maven-obr-plugin.html[Maven OBR Plugin]
* link:subprojects/apache-felix-maven-osgi-plugin.html[Maven OSGi Plugin]
* link:subprojects/apache-felix-maven-scr-plugin.html[Maven SCR Plugin]
* link:subprojects/mosgi-managed-osgi-framework.html[MOSGi Managed OSGi framework]
* link:subprojects/apache-felix-osgi-core.html[OSGi Core]
* link:subprojects/apache-felix-script-console-plugin.html[Script Console Plugin]
* link:subprojects/apache-felix-serialization-framework.html[Serialization Framework]
* link:subprojects/apache-felix-upnp.html[UPnP]
* link:subprojects/apache-felix-user-admin.html[User Admin]
* xref:documentation/subprojects/apache-felix-autoconf.adoc[Auto Configuration]
* xref:documentation/subprojects/apache-felix-commons.adoc[Commons]
* xref:documentation/subprojects/apache-felix-deployment-admin.adoc[Deployment Admin]
* xref:documentation/subprojects/apache-felix-jaas.adoc[JAAS Support]
* xref:documentation/subprojects/apache-felix-lightweight-http-service.adoc[Lightweight HTTP Service]
* xref:documentation/subprojects/apache-felix-manifest-generator-mangen.adoc[Manifest Generator (mangen)]
* xref:documentation/subprojects/apache-felix-maven-obr-plugin.adoc[Maven OBR Plugin]
* xref:documentation/subprojects/apache-felix-maven-osgi-plugin.adoc[Maven OSGi Plugin]
* xref:documentation/subprojects/apache-felix-maven-scr-plugin.adoc[Maven SCR Plugin]
* xref:documentation/subprojects/mosgi-managed-osgi-framework.adoc[MOSGi Managed OSGi framework]
* xref:documentation/subprojects/apache-felix-osgi-core.adoc[OSGi Core]
* xref:documentation/subprojects/apache-felix-script-console-plugin.adoc[Script Console Plugin]
* xref:documentation/subprojects/apache-felix-serialization-framework.adoc[Serialization Framework]
* xref:documentation/subprojects/apache-felix-upnp.adoc[UPnP]
* xref:documentation/subprojects/apache-felix-user-admin.adoc[User Admin]

0 comments on commit 9f25791

Please sign in to comment.