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

Documentation updates for branch 0.2 #617

Merged
merged 5 commits into from
Aug 28, 2020

Conversation

sameerz
Copy link
Collaborator

@sameerz sameerz commented Aug 27, 2020

Signed-off-by: Sameer Raheja sraheja@nvidia.com

Changes:
*** Home
- [X] Need More text around "Ease of Use"
*** Getting Started
- [X] Change "Add the following jars: " to "The following jars: "
- [X] Change "Set the config spark.plugins to com.nvidia.spark.SQLPlugin" to "To set the config spark.plugins to com.nvidia.spark.SQLPlugin"
*** On-Prem
- [X] Remove reference to CUDA 10.0
- [X] Change the following in two places: "Use the following configuration settings when running Spark on YARN, changing the amounts as necessary: " to "Use the following configuration settings when running Spark on YARN, changing the values as necessary: "
- [X] Advanced Configuration: Fix the link to configs.md
- [X] Monitoring: Add an image of the explain output
*** GCP Dataproc
- [X] notebook demos on GCP link is broken, fix to point to github repository (main or branch-0.2?) - linked to branch-0.2 for now since main branch does not include docs/demo, fix in a future release
- [X] Add the following text above the second bullet list: "The script below will initialize with the following: "
- [X] Change "export REGION=[Your Prefer GCP Region]" to "export REGION=[Your Preferred GCP Region]
- [X] Precompiled XGBoost4j link needs to be fixed
*** Compatibility
- [X] Fix link to issue #133 in "however both dates and timestamps are read incorrectly before the Gregorian calendar transition as described here."
- [X] In the String to Timestamp section, remove periods after "Supported on GPU" and add a link from "Partial [1]" to the footnote [1].
*** Testing
- [X] Change "dbgen has various options, one way to generate the data. " to "dbgen has various options to generate data. "
- [X] Change dependig to depending
*** Filenames:
- [X] getting-started-menu.md -> getting-started.md
- [X] getting-started.md -> getting-started-on-prem.md
- [X] getting-started-with-rapids-accelerator-on-databricks.md -> getting-started-databricks.md

Signed-off-by: Sameer Raheja <sraheja@nvidia.com>
@sameerz sameerz added the documentation Improvements or additions to documentation label Aug 27, 2020
@sameerz sameerz self-assigned this Aug 27, 2020
docs/FAQ.md Outdated Show resolved Hide resolved
docs/FAQ.md Outdated Show resolved Hide resolved
Signed-off-by: Sameer Raheja <sraheja@nvidia.com>
@sameerz
Copy link
Collaborator Author

sameerz commented Aug 27, 2020

Added a section in Compatibility.md to document issue #119

docs/get-started/getting-started-gcp.md Show resolved Hide resolved
docs/testing.md Outdated Show resolved Hide resolved
docs/index.md Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
Signed-off-by: Sameer Raheja <sraheja@nvidia.com>
@jlowe
Copy link
Member

jlowe commented Aug 27, 2020

I think this PR shows we need a CI check for broken Markdown links. Filed #618 to track this.

Signed-off-by: Sameer Raheja <sraheja@nvidia.com>
docs/testing.md Outdated Show resolved Hide resolved
Signed-off-by: Sameer Raheja <sraheja@nvidia.com>
@jlowe
Copy link
Member

jlowe commented Aug 27, 2020

build

@sameerz sameerz added this to the Aug 17 - Aug 28 milestone Aug 27, 2020
@sameerz sameerz merged commit d758cb4 into NVIDIA:branch-0.2 Aug 28, 2020
@sameerz sameerz deleted the branch-0.2-documentation-updates branch October 28, 2020 17:32
@sameerz sameerz restored the branch-0.2-documentation-updates branch October 28, 2020 17:33
@sameerz sameerz deleted the branch-0.2-documentation-updates branch October 28, 2020 17:33
nartal1 pushed a commit to nartal1/spark-rapids that referenced this pull request Jun 9, 2021
* Documentation updates for branch 0.2

Signed-off-by: Sameer Raheja <sraheja@nvidia.com>

* Added .md extension, added documentation for issue NVIDIA#119.

Signed-off-by: Sameer Raheja <sraheja@nvidia.com>

* Add back .md extensions on links

Signed-off-by: Sameer Raheja <sraheja@nvidia.com>

* Update get-started/getting-started.md link in index.md

Signed-off-by: Sameer Raheja <sraheja@nvidia.com>

* Fix getting started link in testing.md

Signed-off-by: Sameer Raheja <sraheja@nvidia.com>
nartal1 pushed a commit to nartal1/spark-rapids that referenced this pull request Jun 9, 2021
* Documentation updates for branch 0.2

Signed-off-by: Sameer Raheja <sraheja@nvidia.com>

* Added .md extension, added documentation for issue NVIDIA#119.

Signed-off-by: Sameer Raheja <sraheja@nvidia.com>

* Add back .md extensions on links

Signed-off-by: Sameer Raheja <sraheja@nvidia.com>

* Update get-started/getting-started.md link in index.md

Signed-off-by: Sameer Raheja <sraheja@nvidia.com>

* Fix getting started link in testing.md

Signed-off-by: Sameer Raheja <sraheja@nvidia.com>
tgravescs pushed a commit to tgravescs/spark-rapids that referenced this pull request Nov 30, 2023
…IDIA#617)

Signed-off-by: spark-rapids automation <70000568+nvauto@users.noreply.github.com>

Signed-off-by: spark-rapids automation <70000568+nvauto@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants