Hugo website first draft #14
Conversation
website/build_site.sh
Outdated
| cp ../LICENSE content/ | ||
| cp ../README.md content/_index.md | ||
| mv content/documentation/README.md content/documentation/_index.md | ||
| sed -i 's/.md/\//g' *.md |
There was a problem hiding this comment.
not the most specific regex in the world, but it works? hm should the . be escaped? I'm no good with sed
|
|
||
| ## Examples | ||
|
|
||
| Code and documentation for examples of using MLOS to optimize a system are described in [documentation/03-ExampleUsage.md](./documentation/04-ExampleUsage.md) and in the [source/Examples](./source/Examples/) tree. | ||
| Code and documentation for examples of using MLOS to optimize a system are described in the [Notebooks](./notebooks/) section. Additional code is in the [source/Examples](https://github.com/microsoft/MLOS/tree/main/source/Examples) source directory. | ||
| You can find the source of the notebooks [on github as well](https://github.com/microsoft/MLOS/tree/main/source/Mlos.Notebooks). |
There was a problem hiding this comment.
Do relative links not work here?
One issue with this is if they're browsing on one commit of the tree, then it could drop them to a different one.
There was a problem hiding this comment.
relative from where to where? this is rendered as a html on microsoft.github.io/mlos so I'm not sure where you'd want to link from there.
There was a problem hiding this comment.
This is the top level README.md, so if I for some reason end up at https://github.com/amueller/MLOS/tree/hugo_website, then if I click the "Prerequisites" link, I will end up on your version of that page still. On the other hand the "source/Examples" link will now send me back to the original repo with a different revision.
There was a problem hiding this comment.
Yes. I'm just asking where else it should send you for the rendered page, because there is no relative paths to the source, right?
I can also remove this but then there is no link to github from the rendered pages.
There was a problem hiding this comment.
For the rendered page I think we can send them to the main branch version as you outlined here - that makes perfect sense to me since they're already navigating from an external source.
It was moreso can we do that (e.g. with more sed magic?) but still keep the relative links inside the git markdown?
(the answer to that may be no)
There was a problem hiding this comment.
I don't see how we would do that. Maybe if the link ends with a / it should go to github? But that seems super brittle and we probably also need to start using a markdown parser if we want to do these kinds of rewrites.
There was a problem hiding this comment.
I think I see your point now. A hackish way I could see to do it would be to append an anchor to the link and then regexp replace those strings specially.
For instance:
[source/Examples/](./source/Examples/#mlos-github-tree-browse)
sed -r -e 's|\(\.(/[^#]+)#mlos-github-tree-browse\)|(https://github.com/microsoft/MLOS/tree/main/\1)/'However, your point about it being brittle is well taken and this is perhaps not worth it, so I'm fine if you just want to leave these as is.
There was a problem hiding this comment.
the anchor is a neat idea, I was wondering how we could attach information to the link. But I think it's fine to leave as-is for now.
|
We should make a separate issue for tracking regenerating this and deploying it via CI. |
Also probably documenting how to. |
this is a very basic version of the hugo website, no sphinx yet.