Skip to content

Commit

Permalink
Bump Maven Site Plugin AND Maven Fluido Skin
Browse files Browse the repository at this point in the history
Both need to be updated in tandem to get proper rendering results.
  • Loading branch information
michael-o committed May 12, 2024
1 parent 20c1486 commit 331ab8c
Show file tree
Hide file tree
Showing 19 changed files with 65 additions and 65 deletions.
4 changes: 2 additions & 2 deletions content/markdown/code-quality-management.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Code Quality Management
# Code Quality Management
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
Expand All @@ -22,7 +22,7 @@ Some existing Maven plugins use code analysis technologies (like
page lists technologies and platforms that know how to aggregate all
this information to offer enhanced quality management functionalities.

### Quality management technologies and platforms
## Quality management technologies and platforms

Following is an alphabetical list of those we've heard mentioned around
the Maven community:
Expand Down
20 changes: 10 additions & 10 deletions content/markdown/community.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## The Maven Community
# The Maven Community
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
Expand All @@ -24,39 +24,39 @@ and assist other users in need. This is a quick guide outlining
what members of the Maven community can do to make the system work
better for everyone.

### Helping With Maven
## Helping With Maven

There is already a comprehensive [Guide to Helping With
Maven](./guides/development/guide-helping.html). That guide focuses upon
beginning as a supporter, with information on how to help the coding
effort.

#### Commit Questions or Answers to the Maven User FAQ
### Commit Questions or Answers to the Maven User FAQ

If you find things which are not correct or could be
explained in a better way or you simply miss things
do not hesitate to contact the maven community via
the users mailing list and tell us about it.

#### Help Log Defects in JIRA
### Help Log Defects in JIRA

Just as any other healthy project requires a quick turn-around on
defects, and a transparent method of users to have their wishes heard,
so too does Maven need your help. Refer to the [Issue
Management](./issue-management.html) page.

#### Developers
### Developers

For Maven developers, committers, PMC: there is a [Developers
Guide](./developers/index.html).

### Being a Good Maven Citizen
## Being a Good Maven Citizen

The concept of a public repository built into the core architecture of
Maven makes it necessarily community-centric. There are a few simple
things that Maven users may do to help keep that community thriving.

#### Be a Kind Public Repository User
### Be a Kind Public Repository User

The best thing that a user can do is to set up their own remote
repository mirror containing the projects needed: this is called a
Expand All @@ -74,18 +74,18 @@ Please take only the jars you need. We understand this is may entail
more work, but grabbing more than 1,7 TiB of binaries really kills our
servers.

### User Gathering Spots
## User Gathering Spots

These are a few of the watering holes around which Maven users tend to
gather.

#### Mailing Lists
### Mailing Lists

Maven has a number of [Mailing Lists](./mailing-lists.html), and the Maven
User List is specifically dedicated to answering questions about all
Maven things.

#### Slack
### Slack

For people actively contributing to Maven, especially committers, there
is [the ASF Slack workspace](https://infra.apache.org) available to discuss
Expand Down
20 changes: 10 additions & 10 deletions content/markdown/developers/conventions/jira.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Maven JIRA Conventions
# Maven JIRA Conventions
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
Expand All @@ -19,7 +19,7 @@ under the License.
-->
This document describes how Maven developers should use JIRA, our issue management system.

### When To Create a JIRA Issue?
## When To Create a JIRA Issue?

This section discusses when to create a JIRA issue versus just committing a change in Git (eventually through a PR).

Expand All @@ -32,44 +32,44 @@ of more than 100 lines, should have JIRA tickets.
Creating a JIRA issue and referring it in the commit comments simplifies tracking the changes that happen in a release,
using JIRA automatic release notes creation.

### How To Use Issue Details?
## How To Use Issue Details?

This section presents some conventions about the issue fields.

#### Priority
### Priority

Committers have the responsibility to realign priority by editing the issue.

*Reasoning*: having a correct release note

#### Assignee
### Assignee

Committers can assign an issue to a specific committer that person seems to
be well placed to address it.

#### Component/s
### Component/s

Committers have the responsibility to specify the correct component by editing the issue.

*Reasoning*: having a correct release note.

#### Affects Version/s
### Affects Version/s

By default, the Maven team considers that an issue which affects a given version also affects preceding versions. For example, an issue
that affects Maven 3.6.3 also affects 3.6.0, 3.6.1, 3.6.2.
If it is a regression, the committers should specify the affected versions.

*Reasoning*: having a correct release note.

#### Fix Version/s
### Fix Version/s

Update to correct version after merging to master.

#### Time Tracking
### Time Tracking

The Maven team doesn't use this. Committers can if it helps them.

### Further Links
## Further Links

- [JIRA Documentation](https://confluence.atlassian.com/jira064/jira-documentation-720411693.html)
- [What is an Issue?](https://confluence.atlassian.com/jira064/what-is-an-issue-720416138.html)
Expand Down
28 changes: 14 additions & 14 deletions content/markdown/developers/release/maven-core-release.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Releasing Maven
# Releasing Maven
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
Expand Down Expand Up @@ -47,7 +47,7 @@ version. The tag that produced the failed released is left in place for
posterity. So if the release of, say, 3.2.4 fails then we move forward
with 3.2.5.

### Produce Release Candidates
## Produce Release Candidates

For non-alpha/beta releases, release candidates are produced before the actual release.

Expand All @@ -67,15 +67,15 @@ After a reasonable time without regressions found, a wider audience may be polle

Once happy with a release candidate, the full release is performed, with the final version in place.

### Produce the Release
## Produce the Release

To produce a final release, the same process as for standard projects is followed:

- [Maven Project Common Release Procedure](./maven-project-release-procedure.html)

Below describes the additional steps that need to be taken at the points where the website are updated in those instructions.

#### Prepare the Release Notes
### Prepare the Release Notes

Checkout Maven site source <https://github.com/apache/maven-site.git>.

Expand All @@ -84,7 +84,7 @@ Create the release notes:
- create `content/markdown/docs/$version`
- create `content/markdown/docs/$version/release-notes.md` (see other versions for an example)

#### Stage the Latest Documentation
### Stage the Latest Documentation

Once the release is prepared, but before the release vote, the site needs to be staged.

Expand All @@ -97,11 +97,11 @@ mvn scm-publish:publish-scm

This will publish the Maven core site in [/ref/3-LATEST](/ref/3-LATEST).

### Complete the release
## Complete the release

After a successful vote you should do the following steps to finish the release.

#### Add New Version to ASF Distribution Directory
### Add New Version to ASF Distribution Directory

In addition to promoting the repository, the release archives should be
moved to the release svnpubsub tree:
Expand All @@ -110,11 +110,11 @@ moved to the release svnpubsub tree:
svn mv https://dist.apache.org/repos/dist/dev/maven/maven-3/$VERSION https://dist.apache.org/repos/dist/release/maven/maven-3 -m "Publish Maven $VERSION Distribution Archives"
```

#### Update the DOAP Information
### Update the DOAP Information

Edit <https://github.com/apache/maven/blob/master/doap_Maven.rdf> to list the new release.

#### Update the Web Site
### Update the Web Site

Checkout Maven site source <https://github.com/apache/maven-site.git>.

Expand All @@ -124,7 +124,7 @@ Next, update release history `content/markdown/docs/history.md.vm`.

Only deploy the site once the release is present on the mirrors, and the reference documentation has been deployed to [/ref/](/ref).

#### Deploy the Latest Documentation to Target Versioned Location
### Deploy the Latest Documentation to Target Versioned Location

The reference documentation for Maven core source code references and API docs has been staged in a previous step: now it needs to be deployed to its dedicated directory before deploying the web site pointing to the new version.

Expand All @@ -134,21 +134,21 @@ This consists in copying in website svn tree the staging /ref/3-LATEST directory
svn cp https://svn.apache.org/repos/asf/maven/website/components/ref/3-LATEST https://svn.apache.org/repos/asf/maven/website/components/ref/$VERSION -m "Maven $VERSION released"
```

### Information on `/ref/current` mechanism
## Information on `/ref/current` mechanism

The redirection from `/ref/current` to actual Maven version reference is done through `.htaccess` published in site.

#### Deploying the Release Website
### Deploying the Release Website

Once both of the above have synced to the main site and a suitable number of mirrors, proceed to update the web site and produce the announcement.

Commit your changes and then [deploy the main Maven site](../website/deploy-maven-website.html).

#### Remove Old Versions from ASF Distribution Directory
### Remove Old Versions from ASF Distribution Directory

Next, any superseded releases should be removed from the above locations (after confirming that they exist in /www/archive.apache.org/dist/maven).

#### Proceed with Announcement
### Proceed with Announcement

You can now proceed with the steps outlined after deploying the website on [Maven Project Common Release Procedure](./maven-project-release-procedure.html)

10 changes: 5 additions & 5 deletions content/markdown/extensions/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Available Extensions
# Available Extensions

<!--
Licensed to the Apache Software Foundation (ASF) under one
Expand All @@ -25,18 +25,18 @@ it is possible to hook into Maven, e.g. to manipulate the lifecycle.
* [Configure Extensions](/guides/mini/guide-using-extensions.html)
* [Write Extensions](/examples/maven-3-lifecycle-extensions.html)

### Maintained By The Maven Project
## Maintained By The Maven Project

| Extension | Version | Release Date | Description | Source Repository | Issue Tracker
|------------------------------------------------|---------|--------------|-----------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------|-----------------|
|[Build Cache](./maven-build-cache-extension/) | 1.1.0 | 2023-11-27 | Maven Incremental Build and Cache (local and remote). | [Git](https://gitbox.apache.org/repos/asf/maven-build-cache-extension.git) / [GitHub](https://github.com/apache/maven-build-cache-extension/) | [Jira MBUILDCACHE](https://issues.apache.org/jira/browse/MBUILDCACHE)
|[Enforcer](/enforcer/maven-enforcer-extension/) | 3.4.1 | 2023-09-07 | Environmental constraint checking (Maven Version, JDK etc), User Custom Rule Execution. | [Git](https://gitbox.apache.org/repos/asf/maven-enforcer.git) / [GitHub](https://github.com/apache/maven-enforcer/) | [Jira MENFORCER](https://issues.apache.org/jira/browse/MENFORCER)

### Outside The Maven Land
## Outside The Maven Land

A number of other projects provide their own Maven extensions. This includes:

#### Open Source
### Open Source

| Extension | Maintainer | Description
|-----------------------------------------------------------|---------------------|-----------
Expand All @@ -47,7 +47,7 @@ A number of other projects provide their own Maven extensions. This includes:
| [smart-builder](https://github.com/takari/takari-smart-builder) | Takari | The Takari Smart Builder is a replacement scheduling projects builds in a Maven multi-module build.
| [opentelemetry-maven-extension](https://github.com/open-telemetry/opentelemetry-java-contrib/tree/main/maven-extension) | The OpenTelemetry project | The OpenTelemetry Maven Extension instruments builds to gather execution details as traces for build performance optimization and for troubleshooting. <br/>OpenTelemetry traces can be visualized in open source observability solutions such as [Jaeger Tracing](https://www.jaegertracing.io) as well as in commercial solutions.

#### Commercial
### Commercial

| Extension | Maintainer | Description
|--------------------------------------------------------------------------|-------------|-----------
Expand Down
2 changes: 1 addition & 1 deletion content/markdown/glossary.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Glossary
# Glossary
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
Expand Down
2 changes: 1 addition & 1 deletion content/markdown/guides/mini/guide-multiple-modules-4.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Guide to Working with Multiple Modules in Maven 4
# Guide to Working with Multiple Modules in Maven 4
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
Expand Down
2 changes: 1 addition & 1 deletion content/markdown/guides/mini/guide-resolver-transport.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Guide for Resolver Transport
# Guide for Resolver Transport
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
Expand Down
2 changes: 1 addition & 1 deletion content/markdown/issue-management.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Overview
# Overview
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
Expand Down
2 changes: 1 addition & 1 deletion content/markdown/maven-1.x-eol.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## End Of Life Apache Maven 1.x
# End Of Life Apache Maven 1.x
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
Expand Down
2 changes: 1 addition & 1 deletion content/markdown/maven-conventions.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Maven Conventions
# Maven Conventions
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
Expand Down
2 changes: 1 addition & 1 deletion content/markdown/maven-logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ apache-maven-3.x.y
└── ...
</pre></div>

## Configuring logging
## Configuring logging

To configure logging with the [SLF4J Simple][2], you can edit the properties in the
`${maven.home}/conf/logging/simplelogger.properties` file. Please see the linked reference documentation
Expand Down
2 changes: 1 addition & 1 deletion content/markdown/privacy-policy.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Privacy Policy
# Privacy Policy
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
Expand Down
8 changes: 4 additions & 4 deletions content/markdown/repository-management.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Best Practice - Using a Repository Manager
# Best Practice - Using a Repository Manager
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
Expand All @@ -24,7 +24,7 @@ The usage of a repository manager is
considered an essential best practice for any significant usage of Maven.


### Purpose
## Purpose

A repository manager serves these essential purposes:

Expand All @@ -33,7 +33,7 @@ A repository manager serves these essential purposes:
* provide repositories as a deployment destination for your Maven project
outputs

### Benefits and Features
## Benefits and Features

Using a repository manager provides the following benefits and features:

Expand All @@ -48,7 +48,7 @@ also QA or operations teams or even customers
* provides an effective platform for exchanging binary artifacts within
your organization and beyond without the need for building artifact from source

### Available Repository Managers
## Available Repository Managers

The following list (alphabetical order) of open source and commercial repository
managers are known to support the repository format used by Maven. Please refer to the respective linked web sites for further information about repository management in general
Expand Down
2 changes: 1 addition & 1 deletion content/markdown/repository/layout.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Maven2 Repository Layout
# Maven2 Repository Layout
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
Expand Down
Loading

0 comments on commit 331ab8c

Please sign in to comment.