apache / apache/maven-site

merge formats directories into one single markup directory structure

Open
#750 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Java
Stars
123
Forks
301
Avg merge
16h 59m
Merged PRs (30d)
32

Description

### Improvement proposal

with #573 , we're trying to get rid of old APT format because it is now unknown to most people: great

IMHO, one key issue we have with mixing formats is that it has separate directory structures, which makes it hard to find source markup corresponding to visible html url: I created https://issues.apache.org/jira/browse/MSITE-1036 to support multiple markup formats in one single directory

I'm not sure we'll be able to really drop every format (xdoc may remain useful in a few places, or even a small remaining part of apt)
with one single directory structure, once we benefit fro MSITE-1036, this will not be such a big issue as currently

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reading issue #573 and the linked MSITE-1036 discussion, then inspect how the repository currently separates APT, xdoc, and other markup sources. Done means the formats share one directory structure without losing necessary xdoc or remaining APT support, but the issue does not name specific files or tests.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.