Alluxio documentation defects

[apc999]

Summary

This pinned issue is a running list of all documentation defects. If you find any defects or have any suggestions to our documentation site (https://docs.alluxio.io), you can also post under this issue.

Maintainers will periodically clean up issues listed here.

TODO

priority-high (Something missing, misleading or incorrect, plus critical content)

• Talk about server-side encryption for S3 bucket, e.g. when to set alluxio.underfs.s3.secure.http.enabled and alluxio.underfs.s3.server.side.encryption.enabled and alluxio.underfs.s3.endpoint

• Improve S3 API page, there is no introduction on the setup of "EXAMPLE USAGE". e.g., for command curl -i -X PUT http://localhost:39999/api/v1/s3/testbucket, what is testbucket? it is used without any introduction.

• Explanation on Some commands in fsadmin page is too brief, e.g., fsadmin report storage has only one line to explain

• Not all the Alluxio shell fs commands are covered in page https://docs.alluxio.io/os/user/stable/en/basic/Command-Line-Interface.html, including distributedLoad and etc

• Add Quick-Get-started: Running Presto with Alluxio on S3

• Add Quick-Get-started: Running Spark with Alluxio on S3

• Update Use-Cases.html which needs to be aligned with updated message from Alluxio website

• Revisit deploy docs, especially Local, Cluster, Docker, K8S to be more consistent and user-oriented

• Add Glue related instructions to EMR integration documentation

• Pros/Cons on EMR bootstrap vs YARN integration

• Add Impersonation Configure for YARN and Spark page (e.g., Spark on YARN). link at Slack

• Improvement in the "journal management" document: e.g., it is not clear a secondary master can not start with embedded journal (link at Slack); e.g., manually trigger checkpoints with the checkpoint command (bin/alluxio fsadmin checkpoint)

priority-medium (changes will dramatically improve the docs)

• Improve FS API, e.g. More explanation and examples in this page.

• Improve or split Namespace-Management.html. This page is not well structured and currently too long to read.

• Improve or split Alluxio-Storage-Management.html. This page is not well structured and currently too long to read.

• More detailed documentation about generate-tarball script

• More detailed instructions or examples in instructing how to connect to Kerberized HDFS as UFS

• Add link to Spark performance tuning tips to Spark page

priority-low (changes good to have)

• Add "How Alluxio Works page", either restructuring the Architecture and Data Flow page or having a new (link at Slack)

DONE

[zrss]

also want k8s deploy docs in branch-2.0 .....

[apc999]

also want k8s deploy docs in branch-2.0 .....

hi @zrss we do have a k8s deploy doc in branch-2.0:

• https://docs.alluxio.io/os/user/2.0/en/deploy/Running-Alluxio-On-Kubernetes.html
• src: https://github.com/Alluxio/alluxio/blob/branch-2.0/docs/en/deploy/Running-Alluxio-On-Kubernetes.md

[rastogiasr]

Assigned sections for docs update, please take a look at update docs as you get time

[github-actions[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in two weeks if no further activity occurs. Thank you for your contributions.