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

Rewrote manual intro #2581

Merged
merged 8 commits into from
May 21, 2024
Merged

Rewrote manual intro #2581

merged 8 commits into from
May 21, 2024

Conversation

grobmeier
Copy link
Member

Rewriting of the manual intro.

Please comment if you see any missing "fantastic" features that need to be included in the intro or if anything should be removed.

closes #1468

@grobmeier grobmeier requested review from vy and ppkarwasz May 14, 2024 22:46
@grobmeier grobmeier self-assigned this May 14, 2024
@swebb2066
Copy link

Please comment if you see any missing "fantastic" features that need to be included

What about being able to activate additional logging output or disable some output for one or more modules of the running application by changing the configuration file?

To me this is the super-power that a simpler logging solution misses.

grobmeier and others added 4 commits May 16, 2024 12:51
Co-authored-by: Volkan Yazıcı <volkan@yazi.ci>
Co-authored-by: Volkan Yazıcı <volkan@yazi.ci>
Co-authored-by: Volkan Yazıcı <volkan@yazi.ci>
@vy
Copy link
Member

vy commented May 16, 2024

@grobmeier, I reused common content between /index.adoc and manual/index.adoc in 8d47758. I don't prefer pushing commits to other people's PR branches, but I couldn't think of a way to show the include:partial$ concept I mentioned earlier. Feel free to revert it if you find the earlier version is better.

Copy link
Contributor

@ppkarwasz ppkarwasz left a comment

Choose a reason for hiding this comment

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

We could expand the list of features we offer, otherwise it looks good to me.

src/site/antora/modules/ROOT/partials/log4j-features.adoc Outdated Show resolved Hide resolved
src/site/antora/modules/ROOT/partials/log4j-features.adoc Outdated Show resolved Hide resolved
@ppkarwasz
Copy link
Contributor

@grobmeier, can you merge this?

@grobmeier grobmeier merged commit b21a14b into 2.x May 21, 2024
1 check passed
@grobmeier grobmeier deleted the doc/2.x/manual-intro-1468 branch May 21, 2024 18:09

The original concept for Log4j was conceived in early 1996 when the
E.U. SEMPER project decided to develop its own tracing API.
In 2003, the project was donated to the Apache Software Foundation, which became Apache Log4j.
Copy link

Choose a reason for hiding this comment

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

s/which became Apache Log4j/becoming Apache Log4j/

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks @Chealer . if you like, please create a PR and you can see your contribution in this file :-)

Copy link
Contributor

Choose a reason for hiding this comment

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

@Chealer,

You can follow our documentation rewrite on our staging website.
If we there are typos, grammar or other problems, feel free to use the "Edit" button on the top right side of the page to modify the page in Github and submit a PR.

Note: not all the pages have been rewritten yet. At this moment only the #2538 and #2539 pages are new. If you edit other pages, your changes might be lost, when we rewrite them.

Copy link

@Chealer Chealer May 22, 2024

Choose a reason for hiding this comment

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

I made a few remarks which require someone more involved (ideally the author) to intervene. If someone can notice me once that's done and I still notice simple issues after that's solved, thanks, I will consider.
Thank you for the link @ppkarwasz !

Copy link
Member Author

Choose a reason for hiding this comment

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

No problem, I can work through the comments - thanks for adding them @Chealer
Whenever you want to get more involved, please let me or @ppkarwasz know, we are happy about everyone who wants to get their hands dirty :)

vy added a commit that referenced this pull request May 23, 2024
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.

Revamp the manual introduction
5 participants