search

cytomining / DeepProfiler-handbook

Documentation for installing and using of DeepProfiler
https://cytomining.github.io/DeepProfiler-handbook/
6 stars 3 forks source link

Rename files to get cleaner URLs #3

Closed shntnu closed 2 years ago

shntnu commented 2 years ago 
/Users/shsingh/work/repos/software/deepprofiler/DeepProfiler-handbook/DeepProfiler-Handbook/docs/02-structure.md:135: WARNING: 'myst' reference target not found: cellprofiler.org
/Users/shsingh/work/repos/software/deepprofiler/DeepProfiler-handbook/DeepProfiler-Handbook/docs/02-structure.md:135: WARNING: 'myst' reference target not found: Ilastik.org
rsenft1 commented 2 years ago

Hi Shantanu,

Thanks for changing the file names! Before I merge, I had a few questions about the other style changes you made:

1) For the 'deepnote' logo here, where is that supposed to be in the documentation? I looked at your index html file and I'm not immediately seeing it anywhere. 2) I noticed you changed the copy button. I like it! Without wading through all the build files, how did you do this? If I merge your changes, the github action is going to rebuild the book and toss out everything in _build. When I rebuild your book on my local machine, I lose those style changes. If there was a flag you passed in to indicate a style change I could modify the github action. Otherwise I think we'd need to include the assets separately and either modify the config file or action to preserve these changes after the build.

shntnu commented 2 years ago

Hi @rsenft1 -- all I did was rebuild after renaming (and making a minor URL edit in 02-structure.md), so any other differences are entirely explained by the differences in the library versions

If I merge your changes, the github action is going to rebuild the book and toss out everything in _build.

I think this is the right thing to do here -- I didn't realize that GH actions should be the one doing the building :D

When I rebuild your book on my local machine, I lose those style changes.

I'd imagine that's because of differences in library versions

If there was a flag you passed in to indicate a style change I could modify the github action.

Nope; I just copy-pasted this line 😬

https://github.com/cytomining/DeepProfiler-handbook/blob/e4a58b2e84499ef99c0ad391a583dfc266f14ab7/.github/workflows/deploy-book.yml#L35

Otherwise I think we'd need to include the assets separately and either modify the config file or action to preserve these changes after the build.

Nope -- let's just follow the workflow you have (i.e. let GH build it)

Do you think you could add some minimal instructions on the landing page README.md of this repo so that others don't flub as I did? (i.e. don't push the _build, correct?)

rsenft1 commented 2 years ago

Got it! Looks good. I'll merge and the website should be built and active in a few minutes.