Doc changes #173
Merged
Doc changes #173
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Replace cmf-server-ip with cmf-server-url
Remove 2nd line which is not required
Replaced Test-env to pipeline name and added bucket name as "dvc-art" with a note for the user
Updated 'exec_name' to 'exec_id' and 'Test-env' to 'pipeline-name' and included a generic path for defining or utilizing the mlmd file.
Replaced pipeline-name with quotes for easier understanding
Replaced cmf-server-ip with cmf-server-url
Added "dev-art" as a default bucket name
Updated the description of optional parameter -a(artifact_name).
Made changes inside cmf init minios3 command by providing appropriate localhost and IP address.
Sample example is given
Updated Installation and Configuration of CMF.
spelling mistake in python
Made changes inside client and server configuration
update MinIOS3 to minioS3
Added Prerequisite part inside installation step
Replaced "here" with "web page name".
Replaced "Getting Started" to "Getting started with cmf-server" and "Quick start with cmf-client".
Added github repository clone as a prerequisite.
Replaced Getting started to Getting started with cmf-server
Replaced "Getting started" with "Quick start with cmf-client"
Replaced title name
Replaced title name
Made changes in Initialize cmf step
Made changes inside initialization of minioS3.
Made changes inside minioS3 initialization step.
Made some changes inside description of an error and added number bullet point in right way
Replaced getting started of example section with appropriate sentence.
Made changes in minioS3 initialization
added space
Document Formatted
Document Formatted
Document Formatted
Document formatted
changed image
Updated cmf-server-url with x.x.x.x:8080 Added --session-token inside amazons3 section
Added Temporary Security Credentials part inside amazonS3 configuration part
| ## Setup a cmf-client | ||
| cmf-client is a tool that facilitates metadata collaboration between different teams or two team members. It allows users to pull or push metadata from or to the cmf-server. | ||
|
|
||
| Follow the below-mentioned steps for the end-to-end setup of cmf-client:- | ||
|
|
||
| **Pre-Requisites** | ||
|
|
||
| - Python 3.8+ |
There was a problem hiding this comment.
Why did we get rid of python version ?
There was a problem hiding this comment.
We have reorganized the pages. On the main page (i.e., 'CMF in a Nutshell'), we have included all the installation steps for the CMF library, as shown in the image below.
In the 'Getting Started with the CMF Client' page, we have specified that the CMF server and client should be installed after configuring the CMF library, for which installation steps are provided on the main page.
annmary-roy
approved these changes
May 30, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related Issues / Pull Requests
List all related issues and/or pull requests if there are any.
Description
Include a brief summary of the proposed changes.
What changes are proposed in this pull request?
examples in this repository need to be updated too).
Checklist:
uses Google-style formatting and any other formatting that is supported by mkdocs and plugins this project
uses.