Convert raw HTML of Success Stories page so it can be updated using markdown and yaml

Where will this be placed on the new site?

Is it correct that both Rosco and Keel use the same port as 8087? I doubt that they will be using different ports

According to the documentation here it should be add links to the instances tab.
I tried to update the config on the page /applications/{{app}}/config?section=links to add few links, but none of them appear on /applications/{{app}}/clusters/instanceDetails/kubernetes/{{instance}}, is the documentation up to date? looking at the source code here it doesn't seem that the links are being pulled: https://github.com/spinnaker/deck/blob/master/packages/kubernetes/src/instance/details/details.html#L68

We are using Spinnaker 1.26, deployed on an eks cluster

When I visit https://spinnaker.io/changelogs/1.22.0-changelog#breaking-change-suffix-no-longer-added-to-jobs-created-by-kubernetes-run-job-stage, or perhaps more obviously https://spinnaker.io/changelogs/1.22.0-changelog/#breaking-change-spinnaker-dockerfile-giduid-changes, I'm taken to the top of the page, as opposed to the linked section being at the top of the page. These two are examples. I don't think this works for any of the changelog section links.

In other words, instead of seeing:

for both links, I expect to see (approximately):

and

You may also want to shorten the linkTitle frontmatter variable for docs _index.md pages. Right now the long page titles makes the content menu very long.

In the ' Create Load Blance' step.
Deploy failed: Unable to connect to the server: getting credentials: exec: exec: "oci": executable file not found in $PATH

Implement videos area in Success Stories with a slider or grid that allows presentation of ~20 videos and links to the Spinnaker Youtube channel
Design should accommodate video categorization or incorporate Youtube playlists

• What is preferred? A Hugo data file (YAML or TOML) solution that lists and/or categorizes videos? Or dynamically fetching videos from one or more playlists on YouTube channel?

Docs versioning solution

https://spinnaker.io/docs/setup/other_config/artifacts/s3/
https://spinnaker.io/docs/setup/other_config/artifacts/gcs/

In conjunction with configuring S3 and GCS artifact storage/registry, do you have a similar document for configuring Azure? Thank you very much.

The menu is not completely accessible on the smallest screens. We need a new implementation of a mobile navigation

If there is a high-quality version of the favicon (>300px) available I will use that to generate a set of favicons.

Implement updated CDF-standard footer and push to a repo in the CDF org

^I might need a bit more information for this task.

Are the current footer contents what is wanted there, or something different? If so, will there be a design spec?

Header hierarchy in some of the docs pages needs to be changed so that the page menu will work. Specifically, and for a11y reasons as well, there should never be more than one h1 on a page. I assume that can be done internally?

None of the links under this header work: https://spinnaker.io/docs/guides/tutorials/videos/#microsoft-azure

Hi, I try to donwload the cli but I cannot run in linux

spin --help
/usr/local/bin/spin: line 1: ELF: not found
/usr/local/bin/spin: line 2: syntax error: unexpected word (expecting ")")

The binary I think has the wrong type:

file spin 
spin: Mach-O 64-bit x86_64 executable

The urls are:

curl -LO https://storage.googleapis.com/spinnaker-artifacts/spin/1.27.0/linux/amd64/spin
curl -LO https://storage.googleapis.com/spinnaker-artifacts/spin/1.27.1/linux/amd64/spin

• Halyard command ref
  - https://github.com/spinnaker/buildtool/blob/bbc00505b02314c9d17803cb22a615206036cf87/dev/buildtool/__init__.py#L22
  - https://github.com/spinnaker/buildtool/blob/master/dev/buildtool/halyard_commands.py#L546

• Also https://spinnaker.io/reference/api/docs.html etc like this PR: https://github.com/spinnaker/spinnaker.github.io/pull/2151/files

Enable card layout and update content block styling in theme

Landing page layout. Mockup here: https://docs.google.com/drawings/d/1FCzzvnK0a-_dQ5Nn1T4jz4DrXfr4tMzc9BrObMdEw3k/edit

Are there more specs for the styling?

Copying over spinnaker/spinnaker.github.io#2161 to this repo.

Docsy docs automatically renders a description frontmatter string below section and page titles. You may want to move the short descriptions at the beginning of docs pages into that frontmatter variable and out of page content. Ex: "The goal of this codelab is to trigger a Spinnaker pipeline with a Pub/Sub message from GCS upon upload of a tarball."

Lots of nice updates, including better left side navigation, since this repo was created in 2020
How to update: https://www.docsy.dev/docs/updating/

Links seem to have escaping errors.

For example: if you visit https://spinnaker.io/docs/setup/install/providers/kubernetes-v2/k8s-provider/ you will see the following:

current Jekyll URL: https://www.spinnaker.io/concepts/
hugo URL: /docs/concepts

section level redirects should be OK

Example:

[[redirects]]
  from = "/concepts/*"
  to = "/docs/concepts/:splat"
  status = 301
  force = false

Docsy does not support Algolia search in side bar: https://www.docsy.dev/docs/adding-content/navigation/#configure-algolia-docsearch

I'm not sure why it wouldn't be possible to make it work there, so I'm assuming that would just require a bit of extra time to get the script to target the sidebar search instead of the navbar search. But it would probably be better aesthetically to implement the sidebar in only one of these places.

Please review the content hierarchy for the docs, since I'm combining what were a few separate directories from the Jekyll site. Just to make sure this is organized the way you want.

This page refers to a role named role/objectViewer.

At first I suspected this problem might have been due to the modification of the nme of the role but was unable to find any reference to role/objectViewer on the internet (at the exception of on spinnaker.io).

The role that provides the permission needed here is named role/storage.objectViewer

I suggest we fix this by changing the documentation to reflex the use of the role/storage.objectViewer role which provides the following permissions:

$ gcloud iam roles describe roles/storage.objectViewer
description: Read access to GCS objects.
etag: AA==
includedPermissions:
- resourcemanager.projects.get
- resourcemanager.projects.list
- storage.objects.get
- storage.objects.list
name: roles/storage.objectViewer
stage: GA
title: Storage Object Viewer

The reason why this permission is necessary for Docker Container Registry management is so that we can store the service account in a Google Cloud Storage bucket.

The image at the Life of a Bake page (https://spinnaker.io/docs/reference/architecture/loab/) is too small to make any details out does not get larger when using the browser zoom. Right-clicking on the image does not give me any options to open the image in order to get better controls to zoom in.

sudo hal deploy apply fails with

Err:7 https://dl.bintray.com/spinnaker-releases/debians focal InRelease
403 Forbidden

The halyard daemon isn't running yet... starting it manually...
+ Get current deployment
  Success
+ Prep deployment
  Success
Validation in default.stats:
- INFO Stats are currently ENABLED. Usage statistics are being
  collected. Thank you! These stats inform improvements to the product, and that
  helps the community. To disable, run `hal config stats disable`. To learn more
  about what and how stats data is used, please see
  https://www.spinnaker.io/community/stats.

+ Preparation complete... deploying Spinnaker
+ Get current deployment
  Success
+ Apply deployment
  Success
+ Run `hal deploy connect` to connect to Spinnaker.
Updating apt package lists...
Hit:1 http://by.archive.ubuntu.com/ubuntu focal InRelease
Hit:2 http://by.archive.ubuntu.com/ubuntu focal-updates InRelease
Hit:3 http://by.archive.ubuntu.com/ubuntu focal-backports InRelease
Hit:4 http://dl.google.com/linux/chrome/deb stable InRelease
Get:5 https://download.docker.com/linux/ubuntu focal InRelease [52.1 kB]
Hit:6 http://ppa.launchpad.net/chris-lea/redis-server/ubuntu focal InRelease
Err:7 https://dl.bintray.com/spinnaker-releases/debians focal InRelease
  403  Forbidden [IP: 35.157.134.10 443]
Hit:8 http://security.ubuntu.com/ubuntu focal-security InRelease
Hit:9 http://ppa.launchpad.net/deadsnakes/ppa/ubuntu focal InRelease
Hit:10 http://ppa.launchpad.net/openjdk-r/ppa/ubuntu focal InRelease
Reading package lists...
E: Failed to fetch https://dl.bintray.com/spinnaker-releases/debians/dists/focal/InRelease  403  Forbidden [IP: 35.157.134.10 443]
E: The repository 'https://dl.bintray.com/spinnaker-releases/debians focal InRelease' is not signed.
! ERROR Error encountered running script. See above output for more
  details.

https://codelabs.developers.google.com/codelabs/cloud-spinnaker-kubernetes-cd/ returns a 404. Thanks!

The link to the raw job xml config file (https://storage.googleapis.com/jenkins-script-stage-config/scriptJobConfig.xml) fails with a "The specified bucket does not exist" error.

Since Azure have considerably refactored their azure-quickstart-templates repository, the "Azure Kubernetes Source to Prod" Spinnaker documentation is no longer accurate, invalid, and can no longer be followed.

See issue in culprit repository: Azure/azure-quickstart-templates#12093

This is due to the fact that the https://aka.ms/DeployDevOps script on which this documentation depend on, depends on a set of files that are no longer included in the azure-quickstart-templates Azure repository.

Docsy also automatically renders a list of contents for each directory with an _index.* file in the ./contents dir. So where pages have a table of contents written into the landing page that TOC could be removed. (This would make the docs easier to maintain in the long run.)

X-Frame-Options: SAMEORIGIN

Request by Jason McIntosh (Security SIG)

Convert the /path/filename/ old style links to use the Hugo shortcode for links {{< ref “<”filename” >}}

The spincli example documentation (https://spinnaker.io/docs/guides/spin/app/) references this exampe:

$ spin application save --application-name my-app --owner-email [email protected] --cloud-providers "gce, kubernetes"

Application save succeeded

However Spinnaker 1.26.x seems to enforce the following regex for application names: Must match ^([a-zA-Z][a-zA-Z0-9]*)?$ for cloud provider 'gce' and be less than 63 characters.

Hi @lougroshek, something in this commit 136a55eebc2c916892659c8dd05cc6f5aec22519 broke the builds cause the alert shortcode can't be found:

!136a55e ~/spinnaker.io> hugo serve
Built in 249 ms
Error: Error building site: "/Users/brianle/spinnaker.io/content/en/docs/reference/artifacts-with-artifactsrewrite/types/git-repo/_index.md:8:1": failed to extract shortcode: template for shortcode "alert" not found

Implement new “companies using Spinnaker” logo area with all logos in community and success stories
Make logos clickable, linking to case study, testimonial, or video content

• Which of the above do you want? Whichever is available for the given org?
• Is the intent here to have unique pages that house the details of each testimonial/company using Spinnaker? What would the preferred UX be like?
• Will this content still appear in the docs/community section and the Success Stories page, or is it being consolidated to the home page?

Getting Started page custom layout. Content dependency.

The step #2 "Create a 'Deploy to Staging' Pipeline" at https://spinnaker.io/docs/guides/tutorials/codelabs/kubernetes-v2-source-to-prod/#2-create-a-deploy-to-staging-pipeline has duplicate content.

Some of the content starting with the sentence "Supply the following configuration values:" is displayed twice when it should only display once.

Hi @amygroshek,

We've been working on some of our tasks for the new site and had a question about how the layout/customizations/etc are being overridden in the theme.

We didn't see overrides in the top level of spinnaker.io. Our understanding is that this was the most maintainable path for overrides to the Docsy theme. Can you give us some explanation as to why you're doing it this other way (modifying the theme directly)? Since no one works on Spinnaker.io full time, we are doing our best to make sure that the setup is as standard as possible so anyone can pitch in down the line.

CC @aimeeu @dorbin @dnilasor

Implement community calendar page linked to Google Calendar

• What's the GCal source for this?
• Where will this be located on the site?

Provide a list of the things not getting rendered by goldmark. The Spinnaker docs SIG members will review and let you know what can get ripped out.

Known Issues

toc

I'm assuming we can remove this shortcode because docsy inserts a TOC at the bottom of each page that is an _index.md file and has children.

{% include toc %}

spinnaker_user

{% include spinnaker_user id="adevinta_user" %} {% include spinnaker_user id="airbnb_user" %} {% include spinnaker_user id="alto_user" %}

A bunch of what appears to be fetched branch status data on the build status page

http://localhost:1313/docs/v1.19/community/contributing/build-statuses/

{% for branch in page.branches %} {%- capture subject -%}{{branch | capitalize}}{%- endcapture -%} {%- if branch == “master” -%} {%- capture job -%}Flow_BuildAndValidate{%- endcapture -%} {%- else -%} {%- capture job -%}Flow_BuildAndValidate_{{branch | remove: “release-” | replace: “.", “_"}}{%- endcapture -%} {%- endif -%}

Additional attributes on anchor tags

:style="height: 25px”}{:target=”_blank”} {% endfor %}

Mermaid Charts and Graphs

We could add mermaidJS to the theme which would hopefully resolve this, I'm assuming that the Jekyll site was not using server-side Mermaid processing...

graph TB
deck(Deck) –> gate; api(Custom Script/API Caller) –> gate(Gate); gate –> kayenta(Kayenta); gate –> orca(Orca); gate –> clouddriver(Clouddriver); orca –> clouddriver; gate –> rosco(Rosco); orca –> front50; orca –> rosco; gate –> front50(Front50); gate –> fiat(Fiat); orca –> kayenta; clouddriver –> fiat; orca –> fiat; front50 –> fiat; echo(Echo) –> orca; echo –> front50; gate –> echo; gate –> igor(Igor); igor(Igor) –> echo;

hal(Halyard CLI) –> halyard(Halyard Daemon);

classDef default fill:#d8e8ec,stroke:#39546a; linkStyle default stroke:#39546a,stroke-width:1px,fill:none;

classDef halStyle fill:#eebb3c,stroke:#39546a; class halyard,hal halStyle;

classDef external fill:#c0d89d,stroke:#39546a; class deck,api external;

{% include mermaid %}

Built-In Docsy Alternatives

Docsy Shortcodes are documented here. In particular the alert and pageinfo shortcodes may be of use.

The link to the Standard artifact page redirects back to this legacy page

1. The current docs page TOC scrolls with the page content until the footer is reached. Will it do what you need or should I make more modifications.

2. There are also some links above the page contents menu: Edit page, create documentation issue, create project issue. Would you like to keep those or remove them?

There are a coupe broken links on this web page: https://spinnaker.io/docs/guides/tutorials/codelabs/web-labs/

Broken links that need updating are:

• https://codelabs.developers.google.com/codelabs/cloud-spinnaker-kubernetes-cd/
• https://codelabs.developers.google.com/codelabs/bake-and-deploy-pipeline/

These are the specific lines

Hello!

This page has some weird behavior with &region in links (in their text, not URL, to be precise), where they get converted as html entities:

This is strange because they don't have semicolons to behave so, and it gets even more strange, because local build doesn't exhibit this behavior:

I see it in three different browsers, so I assume it's not an issue of my particular browser / extensions, but I'm not familiar enough with toolchain to continue and replicate the bug. However, simply using &region may suffice.