Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
Signed-off-by: James Talton <[email protected]>
  • Loading branch information
jamestalton committed Jun 20, 2024
1 parent 6692631 commit f0d26ae
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 67 deletions.
1 change: 1 addition & 0 deletions docs/Ansible/Ansible Overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[[Hub]]
4 changes: 0 additions & 4 deletions docs/Framework/Ansible UI Framework.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
title: Ansible Framework
---

A framework for building applications using [PatternFly](https://www.patternfly.org).

While PatternFly provides the building blocks and guidance on building applications, PatternFly does not tie together those building blocks and manage the needed state for the developer. This framework adds state management and abstractions for common patterns of application development.
Expand Down
39 changes: 39 additions & 0 deletions docs/Framework/Framework Overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
### Core Components

[PageFramework](./PageFramework)
[PageHeader](./PageHeader)
[PageLayout](./PageLayout)

### Page Components

[PageDashboard](./PageDashboard)
[PageDashboardCarousel](./PageCarousel#pagedashboardcarousel)
[PageDetails](./PageDetails)
[PageForm](./PageForm)
[PageTable](./PageTable)
[PageTabs](./PageTabs)
[PageToolbar](./PageToolbar)

### Components

[BulkActionDialog](./BulkActionDialog)
[BulkConfirmationDialog](./BulkConfirmationDialog)
[EmptyState](./EmptyState)
[PageCarousel](./PageCarousel)
[ReorderItems](./ReorderItems)

### Hooks

#### Framework Hooks

[useBreakPoint](./useBreakPoint)
[useFrameworkTranslations](./useFrameworkTranslations)
[useInMemoryView](./useInMemoryView)
[useIsMounted](./useIsMounted)
[useOpen](./useOpen)
[usePageNavigate](./usePageNavigate)
[useSearchParams](./useSearchParams)
[useSelectDialog](./useSelectDialog)
[useTableItems](./useTableItems)
[useView](./useView)
[useWindowLocation](./useWindowLocation)
66 changes: 3 additions & 63 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,69 +1,9 @@
---
title: Ansible UI
---
The [Ansible UI](https://github.com/ansible/ansible-ui) repo is a mono repo containing the user interfaces making up the Ansible ecosystem.

The Ansible UI repo is a mono repo containing the user interfaces making up the Ansible ecosystem.
[[Ansible Overview]] - Ansible specific documentation for Automation Controller, Event Driven Ansible, and Automation Hub.

### [Hub](Hub-Overview.md)
[[Ansible UI Framework]] - Documentation for the UI framework built by the Ansible team for building applications using [PatternFly](https://www.patternfly.org).

# Core Components

[PageFramework](./PageFramework)
[PageHeader](./PageHeader)
[PageLayout](./PageLayout)

# Page Components

[PageDashboard](./PageDashboard)
[PageDashboardCarousel](./PageCarousel#pagedashboardcarousel)
[PageDetails](./PageDetails)
[PageForm](./PageForm)
[PageTable](./PageTable)
[PageTabs](./PageTabs)
[PageToolbar](./PageToolbar)

# Components

[BulkActionDialog](./BulkActionDialog)
[BulkConfirmationDialog](./BulkConfirmationDialog)
[EmptyState](./EmptyState)
[PageCarousel](./PageCarousel)
[ReorderItems](./ReorderItems)

# Hooks

## Framework Hooks

[useBreakPoint](./useBreakPoint)
[useFrameworkTranslations](./useFrameworkTranslations)
[useInMemoryView](./useInMemoryView)
[useIsMounted](./useIsMounted)
[useOpen](./useOpen)
[usePageNavigate](./usePageNavigate)
[useSearchParams](./useSearchParams)
[useSelectDialog](./useSelectDialog)
[useTableItems](./useTableItems)
[useView](./useView)
[useWindowLocation](./useWindowLocation)

## Common Hooks

### Crud

[useDeleteRequest](./useDeleteRequest)
[useGet](./useGet)
[useGetAllPagesAWX](./useGetAllPagesAWX)
[useGetItem](./useGetItem)
[useGetRequest](./useGetRequest)
[useOptions](./useOptions)
[usePatchRequest](./usePatchRequest)
[usePostRequest](./usePostRequest)

### General

[useActiveUser](./useActiveUser)
[useInvalidateCache](./useInvalidateCache)

### Validation

[useIsValidUrl](./useIsValidUrl)

0 comments on commit f0d26ae

Please sign in to comment.