You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@bookkeeper.apache.org by GitBox <gi...@apache.org> on 2020/10/04 05:59:43 UTC
[GitHub] [bookkeeper] Ghatage opened a new pull request #2426: New Bookkeeper docusaurus based website
Ghatage opened a new pull request #2426:
URL: https://github.com/apache/bookkeeper/pull/2426
The Apache Bookkeeper website is a custom built website. While that is cool, its also additional maintenance for the PMC/Committers.
@sijie suggested that we can follow the same path as the Pulsar project and have a docusaurus based website which uses markdown heavily and is easier to manage and update.
This is a a WIP and this draft PR is to keep the PMC/Committers updated about the progress on the website.
The goal of this PR is to be able to create a basic skeleton of the website with the following pages (and their sub pages) fully fleshed out:
* Project
* Community
* Blog
* Landing page
So with this, the only thing that remains is the rest of the versioned documentation.
That work can be done in smaller modules as follow ups.
This PR will be opened for review and then can be merged once the above mentioned pages are declared to be complete.
cc @eolivelli
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [bookkeeper] eolivelli commented on pull request #2426: New Bookkeeper docusaurus based website
Posted by GitBox <gi...@apache.org>.
eolivelli commented on pull request #2426:
URL: https://github.com/apache/bookkeeper/pull/2426#issuecomment-703656440
` mvn clean -B -nsu apache-rat:check checkstyle:check package -Ddistributedlog -DskipTests -Dorg.slf4j.simpleLogger.defaultLogLevel=ERROR`
> Error: Failed to execute goal org.apache.rat:apache-rat-plugin:0.12:check (default-cli) on project bookkeeper: Too many files with unapproved license: 34 See RAT report in: /home/runner/work/bookkeeper/bookkeeper/target/rat.txt -> [Help 1]
You have to add an exclusion for "site2" in apache-rat plugin in pom.xml
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [bookkeeper] Ghatage commented on pull request #2426: New Bookkeeper docusaurus based website
Posted by GitBox <gi...@apache.org>.
Ghatage commented on pull request #2426:
URL: https://github.com/apache/bookkeeper/pull/2426#issuecomment-703700831
Will fix the rat plugin build problems etc in the next commit.
You will need `yarn` to be installed.
You can build it the following way:
```
cd site2/website/
yarn install
yarn start
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [bookkeeper] eolivelli edited a comment on pull request #2426: New Bookkeeper docusaurus based website
Posted by GitBox <gi...@apache.org>.
eolivelli edited a comment on pull request #2426:
URL: https://github.com/apache/bookkeeper/pull/2426#issuecomment-703656440
CI failed for RAT (license headers)
` mvn clean -B -nsu apache-rat:check checkstyle:check package -Ddistributedlog -DskipTests -Dorg.slf4j.simpleLogger.defaultLogLevel=ERROR`
> Error: Failed to execute goal org.apache.rat:apache-rat-plugin:0.12:check (default-cli) on project bookkeeper: Too many files with unapproved license: 34 See RAT report in: /home/runner/work/bookkeeper/bookkeeper/target/rat.txt -> [Help 1]
You have to add an exclusion for "site2" in apache-rat plugin in pom.xml
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [bookkeeper] Ghatage commented on a change in pull request #2426: New Bookkeeper docusaurus based website
Posted by GitBox <gi...@apache.org>.
Ghatage commented on a change in pull request #2426:
URL: https://github.com/apache/bookkeeper/pull/2426#discussion_r499676975
##########
File path: site2/website/blog/2017-09-26-adding-rss.md
##########
@@ -0,0 +1,10 @@
+---
+title: Adding RSS Support
+author: Eric Nakagawa
Review comment:
Yes, I have to change a whole lot more for Blog posts. Going to copy-paste your HerdDb blogs from LinkedIn and @sijie 's blogs from StreamNative into here. This will be taken out in the next commit.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [bookkeeper] Ghatage commented on pull request #2426: New Bookkeeper docusaurus based website
Posted by GitBox <gi...@apache.org>.
Ghatage commented on pull request #2426:
URL: https://github.com/apache/bookkeeper/pull/2426#issuecomment-703905358
rerun failure checks
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [bookkeeper] Ghatage commented on pull request #2426: New Bookkeeper docusaurus based website
Posted by GitBox <gi...@apache.org>.
Ghatage commented on pull request #2426:
URL: https://github.com/apache/bookkeeper/pull/2426#issuecomment-703806131
Thanks for the reply @nicoloboschi! Yes more help would be welcome!
I am basing this off of pulsar's docusaurus website which @sijie had pointed out to us a while back.
They have a way to translate strings.. need to look into it. The website by itself is a lot of work.
I agree that we should break this down a bit more (commit per page). The current commits are like this because the initial exoskeleton took a lot of changes to work. So hopefully it's only a one time thing.
I have broken down more work for this as of now:
```
1. Need to add more content to Community page
2. Need to add more content to Project page
3. Need to add blog posts from @eolivelli, @jvrao and @sijie to the blogs (just add .md files to blog/)
and the main main MAIN work item:
4. Add versioning page and start porting previous versions of documentation.
```
Looking forward to collaborating with you on this!
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [bookkeeper] eolivelli merged pull request #2426: New Bookkeeper docusaurus based website
Posted by GitBox <gi...@apache.org>.
eolivelli merged pull request #2426:
URL: https://github.com/apache/bookkeeper/pull/2426
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [bookkeeper] nicoloboschi commented on pull request #2426: New Bookkeeper docusaurus based website
Posted by GitBox <gi...@apache.org>.
nicoloboschi commented on pull request #2426:
URL: https://github.com/apache/bookkeeper/pull/2426#issuecomment-703743732
Great, I think it will be easier to keep it up-to-date, some questions:
1) How will be the strings translations handled?
2) We need a README file, at least for developers that wants to check edit locally
3) IMHO It would be more easy to review if you split the PR or commits for each pages (or block of pages) without adding new contents in this PR, moreover we can split the job to more devs (I will be glad to help porting some pages if needed)
Also I tried locally with yarn and it works
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [bookkeeper] eolivelli commented on pull request #2426: New Bookkeeper docusaurus based website
Posted by GitBox <gi...@apache.org>.
eolivelli commented on pull request #2426:
URL: https://github.com/apache/bookkeeper/pull/2426#issuecomment-703870960
In my opinion once we fix rat and the other comment of mine we can merge this patch, this way we have a way to start collaborating and we can assign the various parts if the work to more people
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [bookkeeper] eolivelli commented on a change in pull request #2426: New Bookkeeper docusaurus based website
Posted by GitBox <gi...@apache.org>.
eolivelli commented on a change in pull request #2426:
URL: https://github.com/apache/bookkeeper/pull/2426#discussion_r499624343
##########
File path: site2/website/blog/2017-09-26-adding-rss.md
##########
@@ -0,0 +1,10 @@
+---
+title: Adding RSS Support
+author: Eric Nakagawa
Review comment:
probably we can't commit this name, please change it to "Foo bar" or anything else
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [bookkeeper] Ghatage commented on pull request #2426: New Bookkeeper docusaurus based website
Posted by GitBox <gi...@apache.org>.
Ghatage commented on pull request #2426:
URL: https://github.com/apache/bookkeeper/pull/2426#issuecomment-703928618
@eolivelli we're good to go for initial commit.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org