Add docs link to Setup, Create Repo, Branches, and Admin Pages (#2506)

treeverse · Nov 3, 2021 · d7efbf7 · d7efbf7
1 parent 28a142d
commit d7efbf7
Show file tree

Hide file tree

Showing 8 changed files with 45 additions and 10 deletions.
diff --git a/webui/src/pages/auth/credentials.jsx b/webui/src/pages/auth/credentials.jsx
@@ -55,6 +55,9 @@ const CredentialsContainer = () => {
                     <RefreshButton onClick={() => setRefreshToken(!refreshToken)}/>
                 </ActionGroup>
             </ActionsBar>
+            <div className="auth-learn-more">
+                An access key-pair is the set of credentials used to access lakeFS. <a href="https://docs.lakefs.io/reference/authorization.html#authentication" target="_blank" rel="noopener noreferrer">Learn more.</a>
+            </div>
 
             {(!!createError) && <Error error={createError}/>}
 

diff --git a/webui/src/pages/auth/groups/index.jsx b/webui/src/pages/auth/groups/index.jsx
@@ -66,12 +66,15 @@ const GroupsContainer = () => {
                         msg={`Are you sure you'd like to delete ${selected.length} groups?`}>
                         Delete Selected
                     </ConfirmationButton>
-
                 </ActionGroup>
                 <ActionGroup orientation="right">
                     <RefreshButton onClick={() => setRefresh(!refresh)}/>
                 </ActionGroup>
             </ActionsBar>
+            <div className="auth-learn-more">
+                A group is a collection of users. <a href="https://docs.lakefs.io/reference/authorization.html#authorization" target="_blank" rel="noopener noreferrer">Learn more.</a>
+            </div>
+
 
             {(!!deleteError) && <Error error={deleteError}/>}
 
@@ -135,4 +138,4 @@ const GroupsIndexPage = () => {
     )
 }
 
-export default GroupsIndexPage;
+export default GroupsIndexPage;
diff --git a/webui/src/pages/auth/policies/index.jsx b/webui/src/pages/auth/policies/index.jsx
@@ -64,12 +64,14 @@ const PoliciesContainer = () => {
                         msg={`Are you sure you'd like to delete ${selected.length} policies?`}>
                         Delete Selected
                     </ConfirmationButton>
-
                 </ActionGroup>
                 <ActionGroup orientation="right">
                     <RefreshButton onClick={() => setRefresh(!refresh)}/>
                 </ActionGroup>
             </ActionsBar>
+            <div className="auth-learn-more">
+                A policy defines the permissions of a user or a group. <a href="https://docs.lakefs.io/reference/authorization.html#authorization" target="_blank" rel="noopener noreferrer">Learn more.</a>
+            </div>
 
             {(!!deleteError) && <Error error={deleteError}/>}
 
@@ -132,4 +134,4 @@ const PoliciesIndexPage = () => {
     )
 }
 
-export default PoliciesIndexPage;
+export default PoliciesIndexPage;
diff --git a/webui/src/pages/auth/users/index.jsx b/webui/src/pages/auth/users/index.jsx
@@ -68,12 +68,14 @@ const UsersContainer = () => {
                         msg={`Are you sure you'd like to delete ${selected.length} users?`}>
                         Delete Selected
                     </ConfirmationButton>
-
                 </ActionGroup>
                 <ActionGroup orientation="right">
                     <RefreshButton onClick={() => setRefresh(!refresh)}/>
                 </ActionGroup>
             </ActionsBar>
+            <div className="auth-learn-more">
+                Users are entities that access and use lakeFS. <a href="https://docs.lakefs.io/reference/authorization.html#authorization" target="_blank" rel="noopener noreferrer">Learn more.</a>
+            </div>
 
             {(!!deleteError) && <Error error={deleteError}/>}
 

diff --git a/webui/src/pages/repositories/index.jsx b/webui/src/pages/repositories/index.jsx
@@ -41,7 +41,7 @@ const CreateRepositoryModal = ({show, error, onSubmit, onCancel}) => {
         return (
             <Modal show={show} onHide={onCancel} size="lg">
                 <Modal.Header closeButton>
-                    <Modal.Title>Create A New Repository</Modal.Title>
+                    <ModalTitleContainer/>
                 </Modal.Header>
                 <Modal.Body>
                     <Loading/>
@@ -52,7 +52,7 @@ const CreateRepositoryModal = ({show, error, onSubmit, onCancel}) => {
     return (
         <Modal show={show} onHide={onCancel} size="lg">
             <Modal.Header closeButton>
-                <Modal.Title>Create A New Repository</Modal.Title>
+                <ModalTitleContainer/>
             </Modal.Header>
             <Modal.Body>
                 <RepositoryCreateForm config={response} error={showError} onSubmit={onSubmit} onCancel={onCancel}/>
@@ -204,6 +204,23 @@ const RepositoriesPage = () => {
     );
 }
 
+const ModalTitleContainer = () => {
+    return (
+        <Container fluid="true" className="justify-content-start">
+            <Row>
+                <Col>
+                    <Modal.Title>Create A New Repository</Modal.Title>
+                </Col>
+            </Row>
+            <Row>
+                <Col>
+                    A repository contains all of your objects, including the revision history. <a href="https://docs.lakefs.io/quickstart/repository.html#create-the-repository" target="_blank" rel="noopener noreferrer">Learn more.</a>
+                </Col>
+            </Row>
+        </Container>
+    );
+};
+
 const RepositoriesIndex = () => {
     return (
         <Switch>

diff --git a/webui/src/pages/repositories/repository/branches.jsx b/webui/src/pages/repositories/repository/branches.jsx
@@ -236,6 +236,9 @@ const BranchList = ({ repo, prefix, after, onPaginate }) => {
                 </ActionGroup>
             </ActionsBar>
             {content}
+            <div>
+                lakeFS uses a Git-like branching model. <a href="https://docs.lakefs.io/understand/branching-model.html" target="_blank" rel="noopener noreferrer">Learn more.</a>
+            </div>
         </div>
     );
 };
@@ -274,4 +277,4 @@ const RepositoryBranchesPage = () => {
     )
 }
 
-export default RepositoryBranchesPage;
+export default RepositoryBranchesPage;
diff --git a/webui/src/pages/setup/index.jsx b/webui/src/pages/setup/index.jsx
@@ -89,14 +89,14 @@ server:
                     <Card.Body>
                         <Card.Text>
                             This process will initialize the database schema and a first admin user to access the system.<br/>
-                            Enter an admin username.
+                            <div><a href="https://docs.lakefs.io/quickstart/repository.html#create-the-first-user" target="_blank" rel="noopener noreferrer">Learn more.</a></div>
                         </Card.Text>
                         <Form onSubmit={e => {
                             onSubmit();
                             e.preventDefault();
                         }}>
                             <Form.Group controlId="user-name">
-                                <Form.Control type="text" placeholder="Username" ref={usernameRef} autoFocus/>
+                                <Form.Control type="text" placeholder="Admin Username" ref={usernameRef} autoFocus/>
                             </Form.Group>
 
                             {!!setupError && <Error error={setupError}/>}

diff --git a/webui/src/styles/globals.css b/webui/src/styles/globals.css
@@ -375,6 +375,11 @@ td .form-group {
   border-bottom-width: 0;
 }
 
+.auth-learn-more {
+  margin-top: -20px;
+  margin-bottom: 20px;
+}
+
 .tree-column{
   width: 2px;
 }