[DOCFIX] Reformat docs #17737

ccmao1130 · 2023-07-06T01:24:47Z

What changes are proposed in this pull request?

Moving changes from personal fork to docs branch

Why are the changes needed?

WIP revamping docs

Does this PR introduce any user facing changes?

add "overview" page, different from "introduction" page
add "glossary" page
minor changes in menu

alluxio-bot · 2023-07-06T01:24:50Z

Thank you for your pull request.
In order for us to evaluate and accept your PR, we ask that you sign a contribution license agreement (CLA).
It's all electronic and will take just a few minutes. Please download CLA form here, sign, and e-mail back to cla@alluxio.org

alluxio-bot · 2023-07-06T01:36:42Z

Automated checks report:

PR title follows the conventions: FAIL
- The title of the PR does not pass all the checks. Please fix the following issues:
  - First word of title ("Revamping") is not an imperative verb. Please use one of the valid words
Commits associated with Github account: FAIL
- It looks like your commits can't be linked to a valid Github account.
  Your commits are made with the email chanchan.mao@alluxio.com, which does not allow your contribution to be tracked by Github.
  See this link for possible reasons this might be happening.
  To change the author email address that your most recent commit was made under, you can run:
```
git -c user.name="Name" -c user.email="Email" commit --amend --reset-author
```
  See this answer for more details about how to change commit email addresses.
  Once the author email address has been updated, update the pull request by running:
```
git push --force https://github.com/ccmao1130/alluxio.git overview
```

Some checks failed. Please fix the reported issues and reply 'alluxio-bot, check this please' to re-run checks.

ccmao1130 · 2023-07-06T01:44:04Z

alluxio-bot, check this please

alluxio-bot · 2023-07-06T01:44:07Z

Automated checks report:

PR title follows the conventions: PASS
Commits associated with Github account: FAIL
- It looks like your commits can't be linked to a valid Github account.
  Your commits are made with the email chanchan.mao@alluxio.com, which does not allow your contribution to be tracked by Github.
  See this link for possible reasons this might be happening.
  To change the author email address that your most recent commit was made under, you can run:
```
git -c user.name="Name" -c user.email="Email" commit --amend --reset-author
```
  See this answer for more details about how to change commit email addresses.
  Once the author email address has been updated, update the pull request by running:
```
git push --force https://github.com/ccmao1130/alluxio.git overview
```

Some checks failed. Please fix the reported issues and reply 'alluxio-bot, check this please' to re-run checks.

ccmao1130 · 2023-07-06T01:58:08Z

alluxio-bot, check this please

alluxio-bot · 2023-07-06T01:58:11Z

Automated checks report:

PR title follows the conventions: PASS
Commits associated with Github account: FAIL
- It looks like your commits can't be linked to a valid Github account.
  Your commits are made with the email chanchan.mao@alluxio.com, which does not allow your contribution to be tracked by Github.
  See this link for possible reasons this might be happening.
  To change the author email address that your most recent commit was made under, you can run:
```
git -c user.name="Name" -c user.email="Email" commit --amend --reset-author
```
  See this answer for more details about how to change commit email addresses.
  Once the author email address has been updated, update the pull request by running:
```
git push --force https://github.com/ccmao1130/alluxio.git overview
```

Some checks failed. Please fix the reported issues and reply 'alluxio-bot, check this please' to re-run checks.

alluxio-bot · 2023-07-06T02:21:09Z

Automated checks report:

PR title follows the conventions: PASS
Commits associated with Github account: PASS

All checks passed!

define new property for configurability of update checker, to be used in conjunction with the update checker enabled property. previously the enabled property has its default value set as a build time constant, but the value could be overridden if set in configuration. now the configurability value, which is set at build time, determines if the enabled property can be configured, and if it is, uses its corresponding value. this pattern allows us to lock the enabled value at build time such that a published jar cannot override this enabled property. pr-link: Alluxio#17738 change-id: cid-5e07f324674ebf6ebd395e6a4c297655dd633bce

### What changes are proposed in this pull request? Using the content hash of the file to be the ETag in the s3 api. Add a property key to decide whether to get real content hash when loading file meta from ufs. ### Why are the changes needed? Now we no longer use Xattr to store the etag of the file. And alluxio adds a new option to get real content hash. ### Does this PR introduce any user facing changes? No pr-link: Alluxio#17742 change-id: cid-b91ae9871b9408c5e111668bebb5a398852c229c

### What changes are proposed in this pull request? The delete/create options are currently not passed to the UFS. By passing them to the UFS correctly, we should be able to achieve recursive create/delete. However, note that under Dora structure, when we delete `/a/`, we can't also remove all `/a/*` cache from all workers immediately. Alluxio#17741 pr-link: Alluxio#17724 change-id: cid-fc5550beec4c9425505f624576b7580a9b171996

and remove the --disableTelemetry flag readded the enabled config to set the default value follow up to Alluxio#17738 pr-link: Alluxio#17740 change-id: cid-ee7e1bf3d3f8949249b68374c2d20f54261b6b4d

Fix fuse doc picture pr-link: Alluxio#17744 change-id: cid-7e8abc9afacec5985b6159e0cbcdf73a92177c3c

Support list files through RESTful API Usage example: HTTP GET request http://localhost:28080/files?path=/test `ls` files of the path `/test` and response a JSON string <img width="793" alt="image" src="https://github.com/Alluxio/alluxio/assets/6129818/96b2d98b-1ac2-4014-b417-a92611b55381"> pr-link: Alluxio#17685 change-id: cid-d6e4b80fdebb94684254f4239a4a65d65dd81a5c

Xenorith · 2023-07-07T23:52:05Z

docs/_data/menu-en.yml

@@ -1,38 +1,52 @@
 # These are the ordered category names
-  - title: Overview
+  - title: Overview # i want this item to open a new page when clicked, no drop down arrow


@Zijian-Zhu maybe we can make a differentiation between a title w/ subfiles vs a title with a single file. if it's only a single file, then create the button link instead of the dropdown style. can you see if this is feasible?

docs/_data/menu-en.yml

docs/en/Get-Started.md

docs/en/core-services/Caching.md

docs/en/kubernetes/Metrics-On-Kubernetes.md

docs/en/overview/Glossary.md

Xenorith · 2023-07-08T00:20:21Z

docs/en/overview/Glossary.md

+* Table of Contents
+{:toc}
+
+### Master


master and job master should be considered as completely separate categories

leading master and standby master are subcategories of master but job master does not have any subcategories. secondary master is already effectively dead

also the entire concept of master and its corresponding leading master and standby master may go away very soon. so i actually wouldn't spend too much time until the 3.x architecture makes more progress

okay, i'll ask beinan for more 3.x/dora related terms

docs/en/overview/Glossary.md

The right side bar will stay at the same position while scrolling. example without actually format: ![image](https://github.com/Alluxio/alluxio/assets/107361923/eba16e35-a180-4734-80ee-6d31acc360a2) with actually format: ![image](https://github.com/Alluxio/alluxio/assets/107361923/01d62af9-7b93-4676-b82f-599a65722f14) pr-link: Alluxio#17749 change-id: cid-240f63f35d9b18183833eb93b8f8568ef33a55c0

### What changes are proposed in this pull request? I'm trying to rollback to java 8 to see if it's compatible to prestodb and hive ### Why are the changes needed? Please clarify why the changes are needed. For instance, 1. If you propose a new API, clarify the use case for a new API. 2. If you fix a bug, describe the bug. ### Does this PR introduce any user facing changes? Please list the user-facing changes introduced by your change, including 1. change in user-facing APIs 2. addition or removal of property keys 3. webui pr-link: Alluxio#17751 change-id: cid-ef100538c3abd0a5e3d74be030defc723a5c8cef

make a differentiation between a title w/ subfiles vs a title with a single file. if it's only a single file, then create the button link instead of the dropdown style. This pr is related change based on Alluxio#17737 example without format: ![image](https://github.com/Alluxio/alluxio/assets/107361923/4d53fa9c-ec42-43df-876f-42316ef7b4f1) with format: ![image](https://github.com/Alluxio/alluxio/assets/107361923/36ae2846-9429-43a8-9f4f-cd4d98d30ef7) pr-link: Alluxio#17760 change-id: cid-8c64be79e6e025407145999564eca28290e4642a

### What changes are proposed in this pull request? A new file `CreateBucketTest.java` was created to run putting bucket UTs for S3 proxy based on Dora version. ### Why are the changes needed? The original s3 API unit tests were very messy and irregular. It is difficult for us to confirm which testing scenarios we have correctly covered. We want to set up s3mock as the UFS and reorganize the unit test for S3 proxy based on Dora version. ### Does this PR introduce any user facing changes? none. pr-link: Alluxio#17732 change-id: cid-71c55b0633c197d2effc919668cb7b51d5b32648

alluxio-bot added the cla-missing label Jul 6, 2023

ccmao1130 changed the title ~~[DOCFIX] Revamping docs~~ [DOCFIX] Reformat docs Jul 6, 2023

ccmao1130 force-pushed the overview branch from 8fecb82 to 39592b6 Compare July 6, 2023 01:46

ccmao1130 force-pushed the overview branch 2 times, most recently from d4ca0a5 to c9674b3 Compare July 6, 2023 02:21

Xenorith and others added 4 commits July 6, 2023 00:06

Define default-release and default-testing tarball profiles

bf4b8f4

and remove the --disableTelemetry flag readded the enabled config to set the default value follow up to Alluxio#17738 pr-link: Alluxio#17740 change-id: cid-ee7e1bf3d3f8949249b68374c2d20f54261b6b4d

Zijian-Zhu removed the cla-missing label Jul 6, 2023

LuQQiu and others added 2 commits July 6, 2023 18:58

[DOCFIX] Fix fuse doc picture

d1d678a

Fix fuse doc picture pr-link: Alluxio#17744 change-id: cid-7e8abc9afacec5985b6159e0cbcdf73a92177c3c

Xenorith self-requested a review July 7, 2023 23:48

Xenorith requested changes Jul 8, 2023

View reviewed changes

Zijian-Zhu mentioned this pull request Jul 11, 2023

[DOCFIX] Update the style of nav list #17760

Merged

beinan and others added 5 commits July 11, 2023 14:38

Reformat docs

749df60

delete duplicate files

4af6b61

ccmao1130 force-pushed the overview branch from 669b26f to 4af6b61 Compare July 12, 2023 02:16

remove a br

89adc02

ccmao1130 closed this Jul 12, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DOCFIX] Reformat docs #17737

[DOCFIX] Reformat docs #17737

ccmao1130 commented Jul 6, 2023

alluxio-bot commented Jul 6, 2023

alluxio-bot commented Jul 6, 2023

ccmao1130 commented Jul 6, 2023

alluxio-bot commented Jul 6, 2023

ccmao1130 commented Jul 6, 2023

alluxio-bot commented Jul 6, 2023

alluxio-bot commented Jul 6, 2023

Xenorith Jul 7, 2023

Xenorith Jul 8, 2023

ccmao1130 Jul 12, 2023

[DOCFIX] Reformat docs #17737

[DOCFIX] Reformat docs #17737

Conversation

ccmao1130 commented Jul 6, 2023

What changes are proposed in this pull request?

Why are the changes needed?

Does this PR introduce any user facing changes?

alluxio-bot commented Jul 6, 2023

alluxio-bot commented Jul 6, 2023

ccmao1130 commented Jul 6, 2023

alluxio-bot commented Jul 6, 2023

ccmao1130 commented Jul 6, 2023

alluxio-bot commented Jul 6, 2023

alluxio-bot commented Jul 6, 2023

Xenorith Jul 7, 2023

Choose a reason for hiding this comment

Xenorith Jul 8, 2023

Choose a reason for hiding this comment

ccmao1130 Jul 12, 2023

Choose a reason for hiding this comment