Commit Graph

47 Commits (0e6751bf8e10e775b2dfaf1fdce75b439bb91171)

Author SHA1 Message Date
Mauren Berti 2f39d55857
Changes from code review. 2022-11-19 09:55:43 -05:00
Mauren Berti 74b03f943a
Localization for glossary tag headers. 2022-11-18 21:35:57 -05:00
Tim Bannister 4b8ec4dc73
Add page info to autogenerated pages
Tell the reader when they're viewing an autogenerated page, in case
they want to report an issue - it should help make reports about
autogenerated content stand out.

Co-authored-by: Qiming Teng <tengqm@outlook.com>
Co-authored-by: Shannon Kularathna <ax3shannonkularathna@gmail.com>
2022-09-27 23:47:10 +01:00
Rishit Dagli fc8c3536d1 Remove katacoda warning 2022-06-13 16:36:48 +00:00
Tim Bannister a7c5ec8eda
Extend Katacoda removal warning
Also cover HTML-based interactive tutorials that do not launch Katacoda
from a button. This commit only updates the English localization.
2022-05-29 14:17:54 +01:00
Tim Bannister e173bf4940
Add warning about Katacoda shutdown 2022-05-29 14:07:46 +01:00
Tim Bannister 1e436f4587 Revise page header styles
- more compact headers when announcements are showing
- when no announcement showing, top level docs sections
  (eg Concepts, Tasks, Reference) have a heading in the top nav
- when announcement is showing, rely on the breadcrumb trail plus
  page introduction text for each top level section
- switch from plain black docs header to match other sections
2021-10-13 22:47:29 +01:00
Tim Bannister 8a736308a9 Revise third-party content warning 2021-10-02 16:40:09 +01:00
Qiming Teng 1fac17f532 Remove extra horizontal line and spacing 2021-07-06 14:51:44 +08:00
Karen Bradshaw 71303db06b use docsy page edit/issue setup
setting feedback buttons, primary color setting

update i18n with issue string

remove local edit page string
2020-09-03 16:35:56 -04:00
Kubernetes Prow Robot 81a3f5420a
Merge pull request #23520 from sftim/20200828_revise_available_docs_versions_list
Revise “Supported Versions of the Kubernetes Documentation”
2020-09-01 12:37:50 -07:00
Karen Bradshaw 160364d548 move search.md
add search bar to search page

fix bing anchors
2020-08-28 15:37:46 -04:00
Tim Bannister 7bac2479ad Revise list of available documentation versions
For older releases, the previous rendering wasn't quite right.
Implement a custom layout for the supported versions list

This commit does NOT remove the shortcode named {{< versions-other >}}
because it is still used in some localizations.
2020-08-28 14:58:10 +01:00
Kubernetes Prow Robot f169e99fee
Merge pull request #22043 from sftim/20200624_update_documentation_section_page_headers
Remove hero header from documentation section
2020-08-18 09:15:31 -07:00
Tim Bannister c7ee5d798c Remove hero header from documentation section 2020-08-18 11:13:06 +01:00
Tim Bannister 7e23f0f875 Tidy & fix deprecation warnings
Co-Authored-By: Karen Bradshaw <kbhawkey@gmail.com>
2020-08-16 18:34:09 +01:00
Karen Bradshaw e2dadcf668 adjust title, description order 2020-06-28 06:50:39 -04:00
Tim Bannister e2805d47b5 Move documentation page lead text after the heading
This helps because the lead text follows the page heading on
the section index that links to a page. Consistency helps readability.
2020-06-24 22:01:14 +01:00
Aidan Ranney 0625ced466
Revise the Kubernetes website to use Docsy (#20874)
* Add Docsy, required packages and config

* Apply Docsy integration work to k8s website

This encompasses significant changes to the style system, layout files,
as well as changes to some of the static assets. To examine this work
and the iterations that were performed, the original repository can be
found at https://github.com/gearbox-built/kubernetes-hugo.git

* Address issues found in review

The styling and positioning of the header, footer, some shortcodes and
main container elements are improved. A new partial is added for
favicons. The sidebars, as well as inner table of contents, have been
altered for better positioning and rendering of content. Localization
has also been addressed.

* Enable announcements

The recent Black Lives Matter announcement surfaced issues which have
been addressed.
2020-06-15 12:09:57 -07:00
Celeste Horgan 9caa83d75b Improve announcements implementation
Signed-off-by: Celeste Horgan <celeste@cncf.io>

Co-authored-by: Tim Bannister <tim@scalefactory.com>
2020-06-04 14:20:47 -07:00
Maciej Filocha 50f10c2a1a Fix glossary_aka template 2020-04-28 11:30:06 +02:00
Jie Shen a34bbe4365
Cleanup user journeys related configs and scripts (#18814) 2020-01-30 17:46:19 -08:00
Chaitanya 6a4238aa71 Accessibility updates - main landmark roles (#17106)
* Removed multiple main tags from home page

Signed-off-by: chaitanyakaranam <chaitanya.karanam@yahoo.com>

* Removed multiple occurances of main in case-studies page

Signed-off-by: chaitanyakaranam <chaitanya.karanam@yahoo.com>

* Replaced css for main tag with .main-section class

Signed-off-by: ChaitanyaKaranam <karanam.krishna.25@gmail.com>

* Added main landmark role for all the pages

Signed-off-by: ChaitanyaKaranam <karanam.krishna.25@gmail.com>

* Force checks.

request-checks: true
2019-10-27 04:43:24 -07:00
Chaitanya 920d14f4fc Accessibility Updates (#16633)
* Fixed accessibility issues in home page

Signed-off-by: ChaitanyaKaranam <karanam.krishna.25@gmail.com>

* Fixed accessibility issues for docs/home page

Signed-off-by: chaitanyakaranam <chaitanya.karanam@yahoo.com>

* Fixed accessibility issues for /partners page

Signed-off-by: chaitanyakaranam <chaitanya.karanam@yahoo.com>

* Fixed accessibility issues for /community page

Signed-off-by: chaitanyakaranam <chaitanya.karanam@yahoo.com>

* Update layouts/partials/header.html

Co-Authored-By: Tim Bannister <tim@scalefactory.com>

* Update layouts/partials/footer-scripts.html

Co-Authored-By: Tim Bannister <tim@scalefactory.com>

* Update layouts/index.html

Co-Authored-By: Tim Bannister <tim@scalefactory.com>

* Update content/en/partners/_index.html

Co-Authored-By: Tim Bannister <tim@scalefactory.com>

* Update content/en/community/_index.html

Co-Authored-By: Tim Bannister <tim@scalefactory.com>

* Added missing quotes

* Added landmark roles for search bar and footer

Signed-off-by: chaitanyakaranam <chaitanya.karanam@yahoo.com>

* Changed images alt text

Changed alt text from 'kubernetes community' to 'Kubernetes Conference Gallery'

* Removed verb from iframe title

Signed-off-by: chaitanyakaranam <chaitanya.karanam@yahoo.com>

* Change alt text for GitHub image

Co-Authored-By: Tim Bannister <tim@scalefactory.com>

* Few alt text changes

* Modified alt text
2019-10-05 22:23:09 -07:00
aimeeu d549942636 Add announcement shortcode and partial (#16210)
Add shortcode, partial, and css so we can display an accouncement
site-wide.
Create a shortcode for use in content/en/ _index.html so
announcement is displayed on website landing page.
Create a partial for use in layouts/docs/baseof.html so
announcement is displaye on every page in '<url>/docs/home'
directory.
Add two values to config.toml: announcement (boolean) for toggling
display of announcement; announcement_message, which is the actual
message.

Signed-off-by: Aimee Ukasick <aimeeu.opensource@gmail.com>
2019-09-09 14:22:55 -07:00
Rael Garcia 20842e037a Add localization support for layouts (#13832)
Add layouts/docs/glossary en i18n strings
Add layouts/docs/glossary es i18n strings
Use i18n strings in layouts/docs/glossary
Add layouts/blog/pager en i18n strings
Add layouts/blog/pager es i18n strings
Use i18n strings in layouts/blog/pager
Add layouts/blog/list en  i18n strings
Add layouts/blog/list es  i18n strings
Use i18n strings in layouts/case-studies/list
Add layouts/docs/search en i18n strings
Add layouts/docs/search es i18n strings
Use i18n strings in layouts/docs/search
Add layouts/partials/feedback en i18n strings
Add layouts/partials/feedback es i18n strings
Use i18n strings in layouts/partials/feedback
Set html lang using "{{ .Language }}"
2019-04-16 17:36:01 -07:00
Bjørn Erik Pedersen b51bdc88cc Make it compatible with Hugo 0.55 (#13680)
This commit adds two backwards compatible changes to prepare for the next Hugo version, most notable:

* All the `File` methods on `Page` has been deprecated and will give a warning in the next Hugo version. Adjust this by changing `.Dir` to ´.File.Dir` and similar.
* Version the capture shortcode to use the old behaviour for markdown rendering of shortcode inner content.
2019-04-08 18:19:05 -07:00
June Yi 8e5d7e4829 Make k8s.io/docs/home to support i18n (#12570)
* Make k8s.io/docs/home to support i18n

* Apply kbhawkey's review comment
2019-02-21 08:24:20 -08:00
Luc Perkins c6dd35ba51 Update to Hugo 0.53 and remove all .Site references (#12079)
* Remove all .Site variable references

* Update Hugo version in Travis CI config and Makefile
2019-02-05 08:33:23 -08:00
Zach Corleissen 0b87f30699 Setup to set up (#12367)
Adding a trivial change

Undoing trivial change to trigger deploy
2019-01-24 13:49:01 -08:00
Andrew Chen b3ed053c82 Refactor home page (#10795)
* Fix docs home subnav link name

* change linkTitle to Home

* accept fix from master

* refactor docs home template

* bump

* test

* switch layout to basic

* swap in cards

* test card css

* add launch-cards and launch-card classes

* swap in content

* use different layout name to not affect user journeys

* revert file naming

* revert docsportal.html

* remove main, add kubeadm link

* documentation -> docs

* change kubeadm link
2019-01-23 18:36:23 -08:00
Luc Perkins 4a6a022e61 Update Git info CSS (#10496) 2018-11-24 08:03:52 -08:00
Kayce Basques 59c4712807 add feedback widget to bottom of docs (#11037) 2018-11-20 05:44:49 -08:00
Andrew Chen 58aa2d5c30 Fix edit page button at bottom of pages. (#10517) 2018-10-05 15:13:03 -07:00
Bjørn Erik Pedersen 32014f94b3 Merge missing translations (#10355)
* Merge missing translations

* Disable Norwegian
2018-10-01 12:38:37 -07:00
Bjørn Erik Pedersen 1b5ff98a44 Make the home page into reusable and translatable blocks (#10071)
* Make navigation and UI strings i18n friendly

This commit

* Extracts most UI strings into i18n bundles so they can be translated
* Makes a proper Hugo menu out of the hardcoded menu that is shown on smaller screens
* Changes the language selector logic to navigate to the current page in the other language if possible (e.g. the translation). If not possible, it takes you to the home page for that language.

For testing, this commit also adds Norwegian as a new language. This is turned off.

* Make the home page into reusable and translatable blocks

This commit adds a set of block type shortcodes that is then used to build the home page.

* These shortcodes gets common image resources from a new headless bundle. These resources can be inherited or overridden by translations.
* The hardcoded case studies section on the home page is replaced with a query and a loop.
* The hardcoded feature list on the home page is replaed qith a query and a loop.
2018-09-14 14:47:24 -07:00
Luc Perkins 9ce0cd0906 Add AnchorJS logic for header links (#10155)
* Add AnchorJS JavaScript

* Remove existing inpage_heading logic

* Remove underline from anchor tags

* Use single icon and add touch visibility

* Use paragraph link icon for AnchorJS

* Update Sass to use code formatting in docsContent headers

* Update header size coverage to H3-H6
2018-09-10 13:09:36 -07:00
Andrew Chen ca175df615 Remove unnecessary link (#10154) 2018-08-30 15:02:19 -07:00
Kazuki Suda 964cb2654a Fix not to escape html in in-page headers (#10130) 2018-08-30 05:08:33 -07:00
Sam Foo 22f1f28bfa Remove imported/ references (#10004)
Signed-off-by: GuessWhoSamFoo <sfoohei@gmail.com>
2018-08-21 15:54:33 -07:00
Misty Linville f8e4d35c5f Add JS to linkify in-page H1-H6 (#9751) 2018-08-18 07:36:42 -07:00
Math Costa fcc03c3474 Bing search for China users (#9845)
* Updates readme's site building instructions

* Alters dockerfile to use extended hugo build

This is necessary for the pipes used w/ TOCSS since node-sass was dropped

* WIP for bing search implementation

* Implements Bing search instead of google

* Makes bing the default result provider and uses google and it's available

* Adds pagination to bing and replaces the $.get call with a $.ajax call

* front adjust

* bing limit pagination

* Adds break if there are less than 10 pages worth of results on bing search

* Adds proper google script ref and proper config id

* Removes console.log call
2018-08-16 11:47:07 -07:00
Misty Linville 5ae0d0dd8d Reorganize docs contrib guide (#9510)
* Reorganize docs contrib guide

* Address first round of feedback from Brad, Jared

* Standardize on 'SIG Docs'

* Address more feedback

* Rewrites to participating.md

* Tweak navigation titles

* Document PR Wrangler

* Document SIG Docs chairperson

* Fix codeblock that shows how to use <codenew>

It was being interpreted as a Hugo shortcode.
2018-08-06 16:15:57 -07:00
Misty Linville 1b914f4ac7 Add Git info to per-page template (#9309)
* Add per-page Git commit info

* Try moving the buttons down below the page TOC

* Add page history to page footer
2018-07-02 16:17:19 -07:00
Takuya Tokuda b24f6327bf Fix a bug that the personal-data description is not displayed in docs/home/. (#8712) 2018-06-06 13:12:25 -07:00
Takuya Tokuda 6ff5ca460f wrap sentence by p tag (#8785) 2018-06-01 20:46:55 -07:00
Bjørn Erik Pedersen 7f3b633aa0 Convert site to Hugo (#8316)
This commit converts content and layout to use Hugo.
2018-05-05 09:00:51 -07:00