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

[Improvement] Improve docs for relasing 0.7.0 #2931

Merged
merged 5 commits into from
Jun 19, 2024

Conversation

zhoujinsong
Copy link
Contributor

Why are the changes needed?

Fix some issues of docs for releasing 0.7.0

Brief change log

  • Fix some doc issues

How was this patch tested?

  • Add some test cases that check the changes thoroughly including negative and positive cases if possible

  • Add screenshots for manual tests if appropriate

  • Run test locally before making a pull request

Documentation

  • Does this pull request introduce a new feature? (no)
  • If yes, how is the feature documented? (not applicable )

@github-actions github-actions bot added type:docs Improvements or additions to documentation module:core Core module labels Jun 17, 2024
## Start AMS

Enter the directory amoro-x.y.z and execute bin/ams.sh start to start AMS.

```shell
cd amoro-x.y.z
bin/ams.sh start
$ cd amoro-x.y.z
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

apache-amoro-x.y.z-bin

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The extracted folder name is still amoro-x.y.z, reference:https://github.com/apache/amoro/blob/master/amoro-ams/dist/src/main/assemblies/bin.xml#L28

## Delete catalog
When a user needs to delete a Catalog, they can go to the details page of the Catalog and click the Remove button at the bottom of the page to perform the deletion.

{{< hint info >}}
Before deleting a Catalog, AMS will verify whether there is metadata for tables under that Catalog.
Before deleting a internal catalog, AMS will verify whether there is metadata for tables under that Catalog.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

an internal catalog

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

@zhoujinsong
Copy link
Contributor Author

I have made some changes due to the review suggestion, PTAL. @tcodehuber @baiyangtx

Copy link
Contributor

@tcodehuber tcodehuber left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@zhoujinsong zhoujinsong merged commit 28780d3 into apache:master Jun 19, 2024
4 checks passed
@zhoujinsong zhoujinsong deleted the improve-docs branch June 19, 2024 03:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
module:core Core module type:docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants