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

Rename notebooks and move them to 'content' subdirectories #141

Merged
merged 2 commits into from
Nov 20, 2023

Conversation

tomdonaldson
Copy link
Contributor

This is our initial attempt at reorganizing the workshop content.

  • Cheat sheet ("CS_") QuickReference notebooks were moved to content/reference_notebooks.
  • Use case exercise and solutions notebooks were moved to content/use_case_notebooks and renamed to indicate the nature of the use case (e.g., proposal_prep.md and proposal_prep_solution.md).

While trying out some different names, I noticed that for long-ish names the last part of the name can be lost in certain displays like the jupyter lab file explorer and in browser tab titles.

Another minor observation is that the <use_case_name>_solution.md files show up before their corresponding <use_case_name>.md file in the jupyter file explorers. This seems odd to me (and is different from the order I see with ls on my Mac).

@stargaser
Copy link
Contributor

Since we named the subdirectory use_case_notebooks and not exercise_notebooks, I am in favor of adding _exercise, like candidate_list_exercise.md. Then I expect Jupyterlab would order the notebooks the way we want.

@bsipocz bsipocz added the infrastructure changes to the infrastructure rather than content label Oct 25, 2023
@tomdonaldson
Copy link
Contributor Author

Since we named the subdirectory use_case_notebooks and not exercise_notebooks, I am in favor of adding _exercise, like candidate_list_exercise.md. Then I expect Jupyterlab would order the notebooks the way we want.

That makes sense to me. I made that change.

@stargaser
Copy link
Contributor

The renaming looks good to me, and no one has raised objections. Does @bsipocz need to change the CI/html-building as part of this PR before it can be merged?

Copy link
Contributor

@stargaser stargaser left a comment

Choose a reason for hiding this comment

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

Looks good to me. The NAVO Python Working Group has had plenty of time to comment on it and no further suggestions or comments have been made.

@bsipocz said she intended to fix the CI in the PR, but that she won't object if we merge it as is, as it will be a little while before she gets to it.

@stargaser stargaser merged commit 38e3c80 into NASA-NAVO:main Nov 20, 2023
1 of 8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
infrastructure changes to the infrastructure rather than content
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants