Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add API doc website #69

Open
wants to merge 14 commits into
base: master
Choose a base branch
from
Open

Add API doc website #69

wants to merge 14 commits into from

Conversation

bact
Copy link
Collaborator

@bact bact commented Feb 1, 2025

  • Add API doc build workflow
  • Fix <text> </text> in Javadoc, it has to be escaped
  • Fix few other Javadoc
  • Convert @author to SPDX-FileContributor

Demo: https://bact.github.io/spdx-java-tagvalue-store/

(Note: a Pages settings to point to gh-pages branch is needed after merge + CI run)

bact added 6 commits December 21, 2024 12:14
Signed-off-by: Arthit Suriyawongkul <[email protected]>
Signed-off-by: Arthit Suriyawongkul <[email protected]>
The tag is not recognisable by Javadoc, has to escaped it.

Signed-off-by: Arthit Suriyawongkul <[email protected]>
Signed-off-by: Arthit Suriyawongkul <[email protected]>
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact bact added the documentation Improvements or additions to documentation label Feb 1, 2025
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact bact requested a review from goneall February 1, 2025 08:50
Copy link
Member

@goneall goneall left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's leave the original notice texts in the source file since it is recommended by the Apache software foundation: https://www.apache.org/legal/apply-license.html

The other changes is to keep Java 8 compliance - last time I tried to change that, I got complaints from the user community that their company is still using Java 8.

pom.xml Outdated Show resolved Hide resolved
pom.xml Outdated Show resolved Hide resolved
pom.xml Outdated Show resolved Hide resolved
@goneall
Copy link
Member

goneall commented Feb 1, 2025

@bact - If you could rebase to the latest, it should fix the CI failure

@goneall
Copy link
Member

goneall commented Feb 1, 2025

Since I would like to get a release out today and this change is mostly documentation, I'll include it in the the next release after 2.0.0-RC2

bact and others added 5 commits February 2, 2025 16:12
Signed-off-by: Arthit Suriyawongkul <[email protected]>

Co-authored-by: Gary O'Neall <[email protected]>
Signed-off-by: Arthit Suriyawongkul <[email protected]>

Co-authored-by: Gary O'Neall <[email protected]>
Signed-off-by: Arthit Suriyawongkul <[email protected]>

Co-authored-by: Gary O'Neall <[email protected]>
@bact
Copy link
Collaborator Author

bact commented Feb 2, 2025

Let's leave the original notice texts in the source file since it is recommended by the Apache software foundation: https://www.apache.org/legal/apply-license.html

@goneall I have add back the short license header as suggested.

Note that the guideline you have mentioned is probably for the code that is developed at the Apache Software Foundation.

From https://www.apache.org/legal/apply-license.html - there's a link to the short license header at https://www.apache.org/legal/src-headers.html#headers and it said:

"Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership"

and the NOTICE file https://www.apache.org/legal/src-headers.html#notice said:

"Apache [PRODUCT_NAME] Copyright [XXXX-XXXX] The Apache Software Foundation This product includes software developed at. The Apache Software Foundation (/)."

--

Btw, for the URL changes, the guideline also said:

"https is acceptable in place of http for the URL"

bact added 2 commits February 3, 2025 01:02
Signed-off-by: Arthit Suriyawongkul <[email protected]>
Signed-off-by: Arthit Suriyawongkul <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants