Need jump lists (anchors) for headings

Question

Need jump lists (anchors) for headings

annajiat opened this issue 2 years ago · comments

Annajiat Alim Rasel commented 2 years ago

@zkamvar
We need to update style for this lesson so that jump lists (anchors for different sections) becomes automatically available for different levels of headings.

Maxim Belkin · Answer 1 · Thu Jan 20 2022 23:15:17 GMT+0800 (China Standard Time)

I can take care of this, Annajiat.

Annajiat Alim Rasel · Answer 2 · Thu Jan 20 2022 23:34:54 GMT+0800 (China Standard Time)

Great, thanks @maxim-belkin

Maxim Belkin · Answer 3 · Thu Jan 20 2022 23:51:52 GMT+0800 (China Standard Time)

No worries! Thanks for reminding me to take care of this. I've synced the lesson style files with carpentries/styles in d285ec4 and anchor links are now automatically added to all HTML headings.

Annajiat Alim Rasel · Answer 4 · Thu Jan 20 2022 23:59:20 GMT+0800 (China Standard Time)

@maxim-belkin
Would it be possible to refer me to some documentation using which I can try learning to do the same too? I've been bugging @zkamvar for this.
Thanks in advance.

Maxim Belkin · Answer 5 · Fri Jan 21 2022 06:55:44 GMT+0800 (China Standard Time)

I have a vague recollection that @fmichonneau documented this process somewhere but it's not that difficult so I can briefly describe it here:

Navigate to the lesson directory on your computer, e.g.:
```
cd /path/to/datacarpentry/lesson
```

Add carpentries/styles repo as a remote:

git remote add styles-repo https://github.com/carpentries/styles.git
git config --local remote.styles-repo.tagOpt --no-tags
git fetch styles-repo

Merge the gh-pages branch of the carpentries/styles repo into the gh-pages branch of the lesson repo:
```
git merge -m "Sync style files with carpentries/styles" styles-repo/gh-pages
```
You might have to resolve Git conflicts here.

Push updated gh-pages branch to the lesson repository:

git push https://github.com/datacarpentry/lesson gh-pages

IIRC, @fmichonneau does this in a separate branch and then submits a PR to merge that branch.

Zhian N. Kamvar · Answer 6 · Wed Jan 26 2022 01:50:28 GMT+0800 (China Standard Time)

Thank you for taking care of this, @maxim-belkin.

@annajiat, regarding the documentation, we created the https://github.com/carpentries/maintainer-resources repository in 2020 to store the meeting minutes and any potentially useful resources for maintainers but were not so great at advertising it.

The process for updating to the latest styles is here:

https://github.com/carpentries/maintainer-resources/blob/main/FLIGHT_RULES.md#update-styles

FWIW, François and I both use the branch-and-PR flow for this so that it's easier to recover when things go sideways.

I apologise for not getting to the other issues you flagged me in... it's been a long week 😞