You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@bigtop.apache.org by "Leona Yoda (Jira)" <ji...@apache.org> on 2022/10/19 07:53:00 UTC
[jira] [Updated] (BIGTOP-3836) Consider about the table of documents
[ https://issues.apache.org/jira/browse/BIGTOP-3836?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Leona Yoda updated BIGTOP-3836:
-------------------------------
Summary: Consider about the table of documents (was: [WIP]Consider about the table of documents)
> Consider about the table of documents
> -------------------------------------
>
> Key: BIGTOP-3836
> URL: https://issues.apache.org/jira/browse/BIGTOP-3836
> Project: Bigtop
> Issue Type: Sub-task
> Reporter: Leona Yoda
> Assignee: Leona Yoda
> Priority: Major
>
> This is subtask of BIGTOP-3773.
> The purpose of this task is
> * Listing up the current contents
> * Check each contents (whether updated / described /)
> * Listing up the wished contents
> to improve the Bigtop user experience.
>
> This task would be update by comment.
> (I will remove the WIP prefix after listing up the contents, it would take a time...)
> h1. Background
> Current Wiki Index(2022/09)
> [https://cwiki.apache.org/confluence/display/BIGTOP]
>
> {code:java}
> - Releases
> - Bigtop 3.1.1 Release Aug. 2022
> - Bigtop 3.1.0 Release May. 2022
> - Bigtop 3.0.1 Release Apr. 2022
> - All releases
> - Getting Started
> - Quickstart Guide
> - How to build and run Bigtop Sandbox
> - How to build Bigtop from git repo
> - Older releases getting started documentation.
> - Support Matrix
> - Known Issues
> - Bigtop 1.2.1 Known Issues
> - Bigtop 1.2.0 Known Issues
> - Building
> - How to build Bigtop-trunk
> - How to build Bigtop-1.1
> - How to build Bigtop-1.0
> - Bigtop CI Setup Guide
> - Deployment & Integration Testing
> - Quickstart Guide: Bigtop Integration Test Framework 2.0
> - Bigtop Provisioner User Guide
> - Deploying Bigtop with PuppetRunning integration, system, and package tests
> - Writing integration and system tests
> - Setting up Bigtop to run HBase system tests
> - Next gen puppet deployment (discussions)
> - Contributing
> - How to Contribute
> - Adding a new component to the big data stack
> - Bigtop Packaging of new Software
> - General
> - Frequently Asked Questions (FAQ)
> - Slides from Bigtop presentations
> - The Community goals of BigTop
> - Social Media Guidelines
> - How to release
> - Events
> - Apache: Big Data North America 2017
> - FOSDEM 2017
> - Apache BigData Budapest, 2015
> - SCALE13x
> - ApacheCon'14
> - July'13 Hackathon{code}
>
> h1. Detail of each contents
> *Releases* and *Support Matrix* are updated. It might be better to integrate these contents.
> h2. Getting Started
> h3. [Quickstart Guide|https://cwiki.apache.org/confluence/display/BIGTOP/Quickstart+Guide%3A+Bigtop+Integration+Test+Framework+2.0]
> Updated.
> This is only for packaging, so it would be better to add deployment. such as
> * how to use bigtop repositories
> * how to deploy with puppet
> h3. [How to build and run Bigtop Sandbox (Experimental)|https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=70256303]
> Last modified on 2017
> Currently bigtop-sandbox is not updated([https://hub.docker.com/r/bigtop/sandbox]).
> It would be better omitting or adding a docker-provisioner example ([https://github.com/apache/bigtop/tree/master/provisioner/docker])
> h3. [How to build Bigtop from git repo|https://github.com/apache/bigtop#for-developers-building-a-component-from-git-repository]
> Last modified on 2019, Pointing GitHub README
> It would be better to move to building section
> h2. Known Issues
> Not updated, only for older versions( < 1.2)
> h2. Building
> h3. [How to build Bigtop-trunk|https://cwiki.apache.org/confluence/display/BIGTOP/How+to+build+Bigtop-trunk]: (development with toolchain, Docker images, etc.)
> Last modified on 2019
> Former part, without docker version, is similar to How to build Bigtop from git repo.
> Latter part, with docker version, refers to QuickStart guild.
> It would be better to integrate with How to build Bigtop from git repo and add descriptions for build options
> h2. Deployment & Integration Testing
> h3. [Quickstart Guide: Bigtop Integration Test Framework 2.0|https://cwiki.apache.org/confluence/display/BIGTOP/Quickstart+Guide%3A+Bigtop+Integration+Test+Framework+2.0]
> Same with Getting Started
> h3. [Bigtop Provisioner User Guide |https://cwiki.apache.org/confluence/display/BIGTOP/Bigtop+Provisioner+User+Guide]
> Last modified on 2021
> It would be better to update with a newer version (> 3.0).
> h3. [Deploying Bigtop with Puppet|https://github.com/apache/bigtop/blob/master/bigtop-deploy/puppet/README.md]
> Updated, refers to GitHub README.
> h3. [Running integration, system, and package tests|https://cwiki.apache.org/confluence/display/BIGTOP/Running+integration%2C+system%2C+and+package+tests]
> Last modified on 2019.
> The documents seemed described well
> h3. [Writing integration and system tests|https://cwiki.apache.org/confluence/display/BIGTOP/Writing+integration+and+system+tests]
> Last modifiied on 2012.
> There are a few description, it might be better to integrate with Running section.
> h3. [Setting up Bigtop to run HBase system tests|https://cwiki.apache.org/confluence/display/BIGTOP/Setting+up+Bigtop+to+run+HBase+system+tests]
> Last modified on 2012.
> It might be better to be refined or omitted.
> h3. [Next gen puppet deployment (discussions)|https://cwiki.apache.org/confluence/display/BIGTOP/Next+generation+Puppet+code+for+Bigtop+deployment]
> Last modified on 2013.
> This is discussion document
> h2. Contributing
> There are additional contents which are not indexed on top page but sidebar.
> h3. [How to Contribute|https://cwiki.apache.org/confluence/display/BIGTOP/How+to+Contribute]
> Updated and maintained well.
> h3. [Adding a new component to the big data stack|https://cwiki.apache.org/confluence/display/BIGTOP/Adding+a+new+component+to+Apache+Bigtop+bigdata+stack]
> Last modified on 2016.
> It shows expectations to new components, not how to.
> The document itself is well enough, the leading block might be redundant.
> h3. [Bigtop Packaging|https://cwiki.apache.org/confluence/display/BIGTOP/Bigtop+Packaging] of new Software
> Updated.
> h2. General
> h3. [Frequently Asked Questions (FAQ)|https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=27825348]
> Last modified on 2012.
> The basic concept has not changed, but the example is old.
> h3. [Slides from Bigtop presentations|https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=51811206]
> Last modified on 2019.
> h3. [The Community goals of BigTop|https://cwiki.apache.org/confluence/display/BIGTOP/The+Community+goals+of+BigTop]
> Last modified on 2015.
> h3. [Social Media Guidelines|https://cwiki.apache.org/confluence/display/BIGTOP/Social+Media+Guidelines]
> Last modified on 2015.
> h3. [How to release|https://cwiki.apache.org/confluence/display/BIGTOP/How+to+release]
> updated.
> h2. [Events|https://cwiki.apache.org/confluence/display/BIGTOP/Events]
> Last modified on 2017.
>
> h1. Contents that should be newly added
> []
>
--
This message was sent by Atlassian Jira
(v8.20.10#820010)