Skip to content

Documentation updates#49

Merged
rm5248 merged 31 commits intoapache:masterfrom
rm5248:documentation-updates
Jan 13, 2021
Merged

Documentation updates#49
rm5248 merged 31 commits intoapache:masterfrom
rm5248:documentation-updates

Conversation

@rm5248
Copy link
Copy Markdown
Contributor

@rm5248 rm5248 commented Dec 30, 2020

This PR does the following:

  • Convert apt/xdoc documentation to markdown
  • Use doxygen for site generation instead of maven
  • Let CMake generate the tar.gz/zip files for releases, as well as signing them
  • Recreate the important generated pages that maven generates in markdown(download, mailing list, source repository)
  • Added a new documentation page with some configuration samples

@ams-tschoening
Copy link
Copy Markdown
Contributor

ams-tschoening commented Jan 10, 2021

How to enable generating a TAR etc. for releases:

Bild_2021-01-10_195745

How to enable generating the SITE:

Bild_2021-01-10_192150

Copy link
Copy Markdown
Contributor

@ams-tschoening ams-tschoening left a comment

Choose a reason for hiding this comment

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

Things look good in general to me, though I have some minor suggestions and questions.

How do you plan to handle obsolete parts of ANT, MVN etc.? With an additional PR or make it part of this or ...?

CMakeLists.txt Outdated
set(CPACK_SOURCE_IGNORE_FILES ".git/;build/")
include(CPack)

add_custom_target( dist
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

How do you execute that target, on the shell and with which command? Visual Studio doesn't seem to provide anything obvious in its UI, installing doesn't seem to trigger that target. Adding ALL like for Doxygen does, but that's not what you intended?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

At least on *nix, this creates a 'make dist' target. With Visual Studio, you need to switch to 'CMake Targets View' in the Solution Explorer. You can then run the target from there.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@rm5248
Copy link
Copy Markdown
Contributor Author

rm5248 commented Jan 11, 2021

Things look good in general to me, though I have some minor suggestions and questions.

How do you plan to handle obsolete parts of ANT, MVN etc.? With an additional PR or make it part of this or ...?

I was going to do that as a separate PR, as I was only focusing on the website building with this PR.

@rm5248 rm5248 merged commit 87aa499 into apache:master Jan 13, 2021
@rm5248 rm5248 deleted the documentation-updates branch January 13, 2021 02:49
@rm5248 rm5248 mentioned this pull request Jan 31, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants