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

[MSITE-1010] Add documentation how site repository inheritance #194

Merged
merged 1 commit into from
Jul 16, 2024

Conversation

Bukama
Copy link
Contributor

@Bukama Bukama commented Jul 7, 2024

Proposed commit message:

[MSITE-1010] Add documentation how site repository inheritance

More information including an example how the site repository configuration is inherited,
when using a parent-pom.

closes #MSITE-1010

Following this checklist to help us incorporate your
contribution quickly and easily:

  • Make sure there is a JIRA issue filed
    for the change (usually before you start working on it). Trivial changes like typos do not
    require a JIRA issue. Your pull request should address just this issue, without
    pulling in other changes.
  • Each commit in the pull request should have a meaningful subject line and body.
  • Format the pull request title like [MSITE-XXX] - Fixes bug in ApproximateQuantiles,
    where you replace MSITE-XXX with the appropriate JIRA issue. Best practice
    is to use the JIRA issue title in the pull request title and in the first line of the
    commit message.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Run mvn clean verify to make sure basic checks pass. A more thorough check will
    be performed on your pull request automatically.
  • You have run the integration tests successfully (mvn -Prun-its clean verify).

If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.

To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.

src/site/apt/examples/inheritancesiterepository.apt Outdated Show resolved Hide resolved
src/site/apt/examples/inheritancesiterepository.apt Outdated Show resolved Hide resolved
src/site/site.xml Outdated Show resolved Hide resolved
src/site/apt/examples/inheritancesiterepository.apt Outdated Show resolved Hide resolved
src/site/apt/examples/inheritancesiterepository.apt Outdated Show resolved Hide resolved
src/site/apt/examples/inheritancesiterepository.apt Outdated Show resolved Hide resolved
@Bukama
Copy link
Contributor Author

Bukama commented Jul 7, 2024

Thanks for the review. Requested changes done.

@michael-o michael-o self-requested a review July 7, 2024 13:42
Copy link
Member

@michael-o michael-o left a comment

Choose a reason for hiding this comment

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

Yet another issue. The problem is not a repository, we do not even have that notion for sites. It is solely about site deployment vs local generation -- as laid out in the JIRA issue. We shouldn't try to introduce the term site repository. I'll review our code to make wording better.

@michael-o
Copy link
Member

See: #195

@Bukama
Copy link
Contributor Author

Bukama commented Jul 8, 2024

Yet another issue. The problem is not a repository, we do not even have that notion for sites. It is solely about site deployment vs local generation -- as laid out in the JIRA issue. We shouldn't try to introduce the term site repository. I'll review our code to make wording better.

I get your point and totally understand it. I updated the PR to avoid the term repository, changed the name of the page (and therefore the menu entry) to distribution management and also fixed some grammar mistakes/bad wording. Would you please have another look?

@michael-o
Copy link
Member

Will review tomorrow again.

@michael-o michael-o self-requested a review July 9, 2024 21:17
@michael-o
Copy link
Member

@Bukama I have added a few improvements, please have a look.

@Bukama
Copy link
Contributor Author

Bukama commented Jul 16, 2024

@Bukama I have added a few improvements, please have a look.

Thanks! I like them!

@michael-o michael-o closed this in f167dac Jul 16, 2024
@michael-o michael-o merged commit f167dac into apache:master Jul 16, 2024
1 check passed
@Bukama Bukama deleted the msite1010 branch July 16, 2024 08:59
michael-o pushed a commit that referenced this pull request Jul 20, 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
2 participants