refactor the old landingpage to the new site generation tool "Hugo". … #21
Conversation
…Add tutorials, components of the gardeneer and foreign links to gardener related pages
|
keep in mind that I am unable to test the CI build lokal in all details. I must change some settings in the hugo.toml and .ci build pipeline without the possibility |
|
I'm seeing a directory called |
related to comment #21 (comment)
|
thanks for the feedback. The docs dir will be cleaned up and rebuild after the first build process. I cleaned it for the very first time by hand. After this the doc folder is a generated mirror of the content dir which didn't contains the typo. |
|
@freegroup Can you please also add some information on how you have setup the system to render external content, also on the CI? and some usage hints ... maybe directly in the Readme.md. |
|
Add some documentation how to run the HUGO site local and how to add a page. |
There was a problem hiding this comment.
-
can we find a better font for the web site ?
This one is hard to read, horizontal letter spacing is too wide,
letters are too thin and monospace is hard to read. The font
used in the documentation is much better to read -
style nit: commit messages don't follow git good practices,
see e.g. https://chris.beams.io/posts/git-commit/ -
split this PR into the following commits, having to wade through >500
files in order to find the ones which need to be reviewed was a pain:-
- add Hugo, leave out the 18MB binary and download that during the build
-
- content written by a human author
-
- website generated by Hugo
-
-
You need to add Hugo to the list of included subcomponents in LICENSE, a copy
of the MIT license is already there
s/independently of one another/independently of each another
…can develop, optimize and deploy a microservice/
|
Whats the status on this one, is this blocked on some issues? |
|
320 and up comments from @msohn and vacation.... |
s/allows you to access the data as if it were on the local disk/allows to access data stored in S3 via the filesystem/ add a link for FUSE https://github.com/libfuse/libfuse
…ivate key and certificate. Then configure the secret name in the TLS configuration section of the ingress specification.
…to bold for the gardener theme
…to bold for the gardener theme
… the feature to store the scroll position of the left hand navigation bar
…ect license file on github.
…eveal, HugoSiteGenerator, Hugo Learn Theme
|
two different repos make no sense in case of "hugo". Hugo generates a set of empty folders. All other stuff are custom files. see 2857c3591b7dbfd6be73937c6201bd22f744e656 |
hugo/content/045_contribute/20_documentation/25_markup/attachments.md
Outdated
Show resolved
Hide resolved
hugo/content/045_contribute/20_documentation/25_markup/notice.md
Outdated
Show resolved
Hide resolved
hugo/content/050-tutorials/content/howto/landscape-setup/_index.md
Outdated
Show resolved
Hide resolved
…same window. User can press "alt" during click to open in new tab or window.
…ntext of Gardener
…the already reqritten one. The rewritten url points sometimes to the "raw" section of github.
…ardener-website-generator repo.
…e-generator" repository
|
|
|
for now LGTM This PR is too large to add further improvements to it, let's do further improvements in new PRs incrementally. Thanks for your patience, I know I am picky |
#21) * refactor the old landingpage to the new site generation tool "Hugo". Add tutorials, components of the gardeneer and foreign links to gardener related pages * remove generated HTML files from cache dir. related to comment #21 (comment) * some documentation how to run the HUGO site local and how to add a page. * fixing breadcrumb. Show only relevant navigation entries * enhance documentation how to build it for local setup * remove "hire" blog entry * remove typo. * remove uppercase word in the middle of a sentence * runs on your Mac => runs on Mac * s/should tend/tend/ * remove unused extra lines * bad wording fixed * s/Additional/Additionally/ s/independently of one another/independently of each another * s/can be developing, optimizing and deploying a certain microservice/can develop, optimize and deploy a microservice/ * change wording * change wording * fix wording * s/an S3 bucket/a S3 bucket/ s/allows you to access the data as if it were on the local disk/allows to access data stored in S3 via the filesystem/ add a link for FUSE https://github.com/libfuse/libfuse * s/cannot interfere with one another/cannot interfere with each other/ * I wouldn't give an explicit percentage here * Create a secret in the namespace of the ingress containing the TLS private key and certificate. Then configure the secret name in the TLS configuration section of the ingress specification. * several text fixes * s/PV's/Persistent Volumes/ * correction of bad english * fix broken link in the index page * correct bad english * rework of the tutorial "access pod locally" * rework of the "Antipatterns" section * rewokr of the bash_kubeconfig helper article * rework article "Storing secrets in github by accident" * rework "initContainer" * rework article "content trust" * rework article "debug a pod" * rework "common docker pitfalls" article * rework article "Dynamic PVC" * rework article "Gardener on AWS" * rework article "Gardener on GCP" * rerwork GPU article * rework HELM article * rework "image pull policy" * rework "kubectl-apiserver" howto * rework "registry permission" howto * rework "network isolation" howto * rework "nload" howto * rework prometheus howto * rework "service access" howto * fix typo * rework service-cache-control howto * rework "ssh into a node" howto * fix curated links * remove unused Slack image * remove unused webfont * remove "thin font" in the main landing page and use a more readable font. (same font as in the documentation section) * remove fontawesome reference in the navigation. "Font-awesome 5 FREE" supports only bold icons wich didn't looks nice in the gardener theme * ignore generated "hugo" content. The content is generated during the "hugo serve" command * change file status and git get a little bit confused. commit empty changes * fix wrong code highlight annotation. "shell" isn't supported - use "bash" instead * avoid "Font Awesome" in the content folder. "Font Awesome 5 FREE" is to bold for the gardener theme * avoid "Font Awesome" in the content folder. "Font Awesome 5 FREE" is to bold for the gardener theme * wrong prettyprint for a Dockerfile code block. * use fresh and latest "learn" theme without any modifications * override the default "learn theme" method to adjust scrolbars and add the feature to store the scroll position of the left hand navigation bar * ignore local setting file * remove local setting file * upgrade "scrollreveal" from 3.3.6->3.4.0 to get a version with a correct license file on github. * add the license condition of all used subcomponents momentJS, ScrollReveal, HugoSiteGenerator, Hugo Learn Theme * avoid UPPERCASE in a title of a howto. It's like shouting at the user. * use "rinse and repeat..." instead of "denglish" wording. * avoid to open always a new tab for each link. Navigate always in the same window. User can press "alt" during click to open in new tab or window. * fix broken link from "blog" entries" to apps or howto section * remove information about "artifactory". This is not relevant in the ontext of Gardener * fix to small font in comment and info boxes. * fix to small font in "attachment" section * rewrite relative URLs to absolute with the original URL and not with the already reqritten one. The rewritten url points sometimes to the "raw" section of github. * add "security guide process" to the landing page documentation * remove all non documentation related content and move them into the gardener-website-generator repo. * remove CI pipeline definition. Buidl is moved to the "gardener-website-generator" repository * move static assets to the generator repo and make the docu part more lean. * remove typo in table header. * add information how the website generation process works
…Add tutorials, components of the gardeneer and foreign links to gardener related pages