Can this repository be made consistent with dev.java?

[danthe1st]

Motivation

I (and I have reason to believe this also applies to other contributors) am confused by inconsistencies between https://dev.java and this repository.

This repository seems to be based on an old version of the dev.java site that doesn't have all articles which means that if authors want to use [link](id:some.article.id) formatting to link to other articles (which I would consider to be the preferred way of writing links between articles), which leads to either using full links or guessing. Furthermore, some of the articles not being present results in warnings when building this repository. Also, since some article groups are not available in this repository, guesses about that have to be made as well (e.g. the Classes and Objects group) for the article directory, id of the article and the file name of the article (specifically the number at the beginning).

Also, there are some inconsistencies between this repository and the site, for example #101 was fixed on the site but this repository still contains the old version and the Javadocs of this repository still refer to Java 19 while the site uses Java 21 which lead to confusion in #97 for example.

Suggestion

Because of these issues, I suggest that

• Javadoc definitions are kept up to date (i.e. when these are changed on dev.java, this is also done in this repository).
• If an article that has a version in this repository is changed on https://dev.java, it should also be changed in this repository.
• Create stubs of all articles, especially in article groups. I can understand not wanting to have the content of some articles in this repository due to copyright/licensing but please at least include a file containing the metadata in this repositories for all articles and article groups present in https://dev.java/learn.

For example, for the VSC article, I could imagine such a stub look like the following

---
id: first_app.vsc
title: Building a Java application in Visual Studio Code
slug: learn/vscode-java
type: tutorial
category: start
layout: learn/tutorial.html
subheader_select: tutorials
main_css_id: learn
description: "An IDE (Integrated Development Environment) allows you to quickly program applications by providing multiple utilities for code development, testing, debugging features, etc. Given the increasing popularity of Visual Studio Code as a universal IDE, you can easily develop your first Java project by installing the Oracle Java Platform Extension."
last_update: 2024-04-22
---

# The content of this article is not available in this repository.

(data taken from https://dev.java/learn/vscode-java/)
If you don't want to include the description in the stub, I could also imagine the empty string being used for that).

The most important parts of that are:

• id
• everything related to the article group/layout so that contributors can easily copy and adapt it for their articles.

but I think it's useful to be able to copy the metadata from another article in the same group.

[carimura]

ya we've stewed on all of this before. it's mostly a time issue. Funny enough I was just updating the javadocs xml file like 30 mins ago before reading this issue so consider that done soon. Backwards updating might be hard. And stubs is just a time thing and considering the license implications.