Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace old workstation docs with new workstation docs #1037

Merged
merged 15 commits into from
Mar 31, 2020

Conversation

IanMadd
Copy link
Contributor

@IanMadd IanMadd commented Mar 11, 2020

Signed-off-by: IanMadd imaddaus@chef.io

This puts the workstation documentation into chef-workstation so we can pull it back into chef-web-docs whenever chef-workstation is promoted.

Description

This PR:

  • adds workstation documentation from the chef-web-docs repo
  • replaces the original hugo theme with the new hugo theme
  • customizes the index page to make it easier to write docs from the chef-workstation repo
  • about_workstation.md has been renamed _index.md and there's a new workstation/single.html template. Users who go to localhost:1313/workstation/ or docs.chef.io/workstation/ will see the About Workstation page.
  • all shortcodes in layouts/shortcodes/ have a ws_ prefix so we can distinguish them from shortcodes in chef-web-docs from other sources.

To Do:

  • There were several pages in the old chef-workstation docs that aren't in chef-web-docs. I don't know where to put them so they're unedited in www/content/workstation/. Some of it is chef-run docs, some is content that could be deleted or edited into pages from chef-web-docs.

Related Issue

chef/release-engineering#983

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Chore (non-breaking change that does not add functionality or fix an issue)

Checklist:

  • I have read the CONTRIBUTING document.
  • I have run the pre-merge tests locally and they pass.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • All commits have been signed-off for the Developer Certificate of Origin.

Signed-off-by: IanMadd <imaddaus@chef.io>
@IanMadd IanMadd requested review from schisamo and jonsmorrow March 11, 2020 22:23
@IanMadd IanMadd requested review from a team as code owners March 11, 2020 22:23
kagarmoe and others added 2 commits March 11, 2020 15:53
Signed-off-by: IanMadd <imaddaus@chef.io>
@IanMadd IanMadd requested a review from a team as a code owner March 11, 2020 23:08
IanMadd and others added 3 commits March 11, 2020 16:51
Signed-off-by: IanMadd <imaddaus@chef.io>
Signed-off-by: IanMadd <imaddaus@chef.io>
I went through and merged, updated, or deleted pages that were left over
after merging the 'chef-web-docs' sources into here. This included
adding more topics top the top level navigation bar as well as details
on new tools (like `chef-run`).

Signed-off-by: tyler-ball <tball@chef.io>
…performed

Signed-off-by: tyler-ball <tball@chef.io>
IanMadd added 4 commits March 31, 2020 13:26
Signed-off-by: IanMadd <imaddaus@chef.io>
Signed-off-by: IanMadd <imaddaus@chef.io>
Signed-off-by: IanMadd <imaddaus@chef.io>
Signed-off-by: IanMadd <imaddaus@chef.io>
Copy link

@kagarmoe kagarmoe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tenor-254765678

IanMadd and others added 2 commits March 31, 2020 14:15
Signed-off-by: IanMadd <imaddaus@chef.io>
Signed-off-by: tyler-ball <tball@chef.io>
Copy link
Contributor

@tyler-ball tyler-ball left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added 1 commit to correct a link from chef/chef to chef/chef-workstation

@@ -2,14 +2,14 @@
title = "Getting Started"
draft = false

aliases = ["getting_started.html", "/workstation_setup.html", "/chefdk_setup.html", "/workstation.html", "/getting_started/"]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In install_workstation.md I linked to [Getting Started](/workstation/getting_started/) - will that break now?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nope! That link worked fine in my local build. Although http://localhost:1313/workstation/workstation_setup/ gives me a 404. I apparently do not understand what these aliases mean :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The alias adds a blank page at that url with a redirect to the page that specifies the alias.

@tyler-ball tyler-ball merged commit 0949da1 into master Mar 31, 2020
@tyler-ball tyler-ball deleted the im/chef-web-docs branch March 31, 2020 23:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants