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

Some minor doc updates #100

Merged
merged 2 commits into from
Dec 16, 2024
Merged

Some minor doc updates #100

merged 2 commits into from
Dec 16, 2024

Conversation

Ciheim
Copy link
Contributor

@Ciheim Ciheim commented Dec 3, 2024

#84

@aradhakrishnanGFDL aradhakrishnanGFDL self-requested a review December 5, 2024 18:04
@aradhakrishnanGFDL
Copy link
Collaborator

@Ciheim looks good to me. It's a bit hard to review without the actual sphinx page, so we can merge this in and work on more docs as needed.

But.. did you address the following in some form? or want to table this for later?

Item 3: Using FRE-CLI section needs major updates, especially to reflect --config option
(check if verbose option is in fre-cli, open issue on this separately if not)

Using FRE-CLI (GFDL only)

@Ciheim
Copy link
Contributor Author

Ciheim commented Dec 14, 2024

@aradhakrishnanGFDL The --config option is explained in the flags section. Do you think there needs to be an example of a config being used for a fre-cli call? What other updates would you suggest for that section?

I've opened a new issue for the verbose option in the fre-cli catalog builder tool.

@aradhakrishnanGFDL
Copy link
Collaborator

@aradhakrishnanGFDL The --config option is explained in the flags section. Do you think there needs to be an example of a config being used for a fre-cli call? What other updates would you suggest for that section?

I've opened a new issue for the verbose option in the fre-cli catalog builder tool.

Got it. There needs to be documentation in the fre-cli land perhaps for fre build catalog etc. There seems to be a hyperlink from the catalog builder docs to fre-cli, so that's good for now. Merging in. Please make sure fre-cli docs are updated coordinating with @ceblanton

@aradhakrishnanGFDL aradhakrishnanGFDL merged commit 9ccdb76 into main Dec 16, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants