Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/master' into cnunciato/docs-toc
Browse files Browse the repository at this point in the history
  • Loading branch information
cnunciato committed Oct 8, 2024
2 parents 20df577 + 51d74d2 commit 5136a2c
Show file tree
Hide file tree
Showing 1,093 changed files with 13,786 additions and 7,147 deletions.
6 changes: 6 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
content/docs/ @pulumi/docs

# Allow CLI docs PRs to be merged automatically.
content/docs/iac/cli/commands/
content/docs/esc/cli/commands/
content/docs/iac/download-install/versions.md

content/tutorials/ @pulumi/docs
content/templates/ @pulumi/docs
2 changes: 1 addition & 1 deletion .github/workflows/build-and-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ jobs:

- uses: peaceiris/actions-hugo@v2
with:
hugo-version: '0.126.0'
hugo-version: '0.135.0'
extended: true

- name: Configure AWS Credentials
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/check-links.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:
- name: Install Hugo
uses: peaceiris/actions-hugo@v2
with:
hugo-version: '0.126.0'
hugo-version: '0.135.0'
extended: true
- name: Run make check_links
run: make check_links
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/check-search-urls.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ jobs:

- uses: peaceiris/actions-hugo@v2
with:
hugo-version: '0.126.0'
hugo-version: '0.135.0'
extended: true

- uses: algolia/setup-algolia-cli@master
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ jobs:
# - name: Install Hugo
# uses: peaceiris/actions-hugo@v2
# with:
# hugo-version: '0.126.0'
# hugo-version: '0.135.0'
# extended: true
# - name: Install node
# uses: actions/setup-node@v2
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/esc-cli.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ jobs:
- name: Install Hugo
uses: peaceiris/actions-hugo@v2
with:
hugo-version: '0.126.0'
hugo-version: '0.135.0'
extended: true
- name: Install node
uses: actions/setup-node@v2
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/generate-provider-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ jobs:
- name: Install Hugo
uses: peaceiris/actions-hugo@v2
with:
hugo-version: '0.126.0'
hugo-version: '0.135.0'
extended: true
- name: setup node
uses: actions/setup-node@v2
Expand Down
3 changes: 3 additions & 0 deletions .github/workflows/pr-closed.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ jobs:
if: github.event.pull_request.head.repo.full_name == github.repository
name: Do cleanup
runs-on: ubuntu-latest
environment: testing
env:
GOPATH: ${{ github.workspace }}/go
steps:
Expand All @@ -38,3 +39,5 @@ jobs:
env:
PULUMI_ACCESS_TOKEN: ${{ secrets.PULUMI_ACCESS_TOKEN }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
DEPLOYMENT_ENVIRONMENT: ${{ vars.DEPLOYMENT_ENVIRONMENT }}
PULUMI_STACK_NAME: ${{ vars.PULUMI_STACK_NAME }}
2 changes: 1 addition & 1 deletion .github/workflows/pull-request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ jobs:

- uses: peaceiris/actions-hugo@v2
with:
hugo-version: '0.126.0'
hugo-version: '0.135.0'
extended: true

- name: Configure AWS Credentials
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/pulumi-cli.yml
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ jobs:
- name: Install Hugo
uses: peaceiris/actions-hugo@v2
with:
hugo-version: '0.126.0'
hugo-version: '0.135.0'
extended: true
- name: Install node
uses: actions/setup-node@v2
Expand Down Expand Up @@ -99,7 +99,7 @@ jobs:
- name: Update version lists
run: |
NL=$'\n'
sed -e "s/<tbody>/<tbody>\\${NL} {{< changelog-table-row version=\"${{ env.PULUMI_VERSION}}\" date=\"$(date +%Y-%m-%d)\" showChecksum=\"true\" >}}/" -i ./content/docs/iac/install/versions.md
sed -e "s/<tbody>/<tbody>\\${NL} {{< changelog-table-row version=\"${{ env.PULUMI_VERSION}}\" date=\"$(date +%Y-%m-%d)\" showChecksum=\"true\" >}}/" -i ./content/docs/iac/download-install/versions.md
working-directory: docs
- name: git status
run: git status && git diff
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/testing-build-and-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ jobs:

- uses: peaceiris/actions-hugo@v2
with:
hugo-version: '0.126.0'
hugo-version: '0.135.0'
extended: true

- name: Configure AWS Credentials
Expand Down
3 changes: 3 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,6 @@ content/docs/reference/pkg
tsconfig.json
package.json
typedoc.json

# Ignore the files we generate during the build and deployment process.
origin-bucket-metadata.json
46 changes: 35 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,22 +183,46 @@ With `make serve-static` running, you can browse to the docs by navigating to ht

All generated docs, including all Node.js, Python, and .NET SDK docs and all Pulumi and Pulumi ESC CLI docs, get checked into this repository.

## Migrating from pulumi-hugo
## Search

The pulumi-hugo repository was archived on May 16, 2024. This repository previously housed most of our website content. This content has now moved to this repository. There is a slight directory structure change in this repo compared to pulumi-hugo. For the most part, everything that was located under the `themes/default` directory in pulumi-hugo now lives under the root directory of this repository, i.e. `themes/default/content/blog` is now under `/content/blog`. Everything still functions the same way it did previously when it comes to local devleopment, e.g. `make ensure`, `make serve`, `make build-assets`, etc.
We use [Algolia](https://www.algolia.com/) for search, and we update the Algolia search index [on every deployment](https://github.com/pulumi/docs/blob/master/scripts/ci-push.sh#L13) of the website. Whether you're adding a new page or updating an existing one, your changes will be reflected in search results within a few seconds of release.

### How to migrate PRs from the pulumi-hugo repo
### Creating findable content

If you have open pull requests in the pulumi-hugo repo, here are the steps to follow in order to move them over to the docs repository. You will need to copy over your files to the docs repo and place them in the new directory location.
We currently index every page of the website, including the blog and the Registry. However, we do not index all of the content of every page &mdash; we only index certain properties of the page. These include:

#### Steps:
1. Clone the docs repo if you haven't done so already.
2. Create a new branch in the docs repository.
3. Copy the files you changed/added to the docs repo. The directory structure is similar to how this repo was configured, except everything under themes/default has been moved to the root. For example, if you have a blog under `themes/default/content/blog/my-cool-blog`, you will need to relocate it under `content/blog/my-cool-blog` in the docs repo.
4. Run make ensure in the docs repo and then a make serve to verify the files have been moved correctly.
5. Push changes to the docs repo.
6. Open a PR in the docs repo to add the changes there.
* Page titles (specifically the `title` and `h1` frontmatter params)
* Page descriptions (specifically the `meta_desc` param)
* Second-level headings (e.g., those prefixed with `##` in Markdown files)
* Keywords, if any (via the `search.keywords` param)
* Authors, if any (via the `authors` param)
* Tags, if any (via the `tags` param)

Because of this, it's important to be thoughtful about the terms you use for these fields, especially titles, keywords, descriptions, and H2 headings. If you want your content to be findable by specific terms, you must make sure those terms exist in one or more of the fields listed above.

For example, if you were writing a guide to building an ETL pipeline with Redshift, and you wanted to make sure the page would be surfaced for queries like `redshift data warehouse etl`, you might construct the page's frontmatter in the following way:

```yaml
title: Build an ETL pipeline with Redshift and AWS Glue
meta_desc: Learn how to combine AWS Glue and Amazon Redshift to build a fully-automated ETL pipeline with Pulumi.
search:
keywords:
- data warehouse
```
In this case, the optional `search.keywords` field is included to cover the terms `data warehouse`, as those terms don't exist in the page's title or description. If it weren't, queries for `data warehouse` would fail to match this particular page.

Certain fields also rank higher than others in terms of their overall relevance. (Titles and keywords, for example, are considered more relevant than descriptions.) For a full list of these rankings, along with all of the rules we apply to the search index, see the [search app in pulumi/docs](https://github.com/pulumi/docs/blob/master/scripts/search/settings.js).

### Keeping pages out of search results

To keep a page from showing up in search results (including on Google, etc.), use the `block_external_search_index` frontmatter parameter:

```yaml
title: My page
...
block_external_search_index: true
```
## Community

Engage with our community to elevate your developer experience:
Expand Down
6 changes: 3 additions & 3 deletions STYLE-GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,13 +76,13 @@ This bit of info is serious. If you missed it, bad things could happen.
- all on one line

```plain
This is a pargraph all on one line. This paragraph is easy to edit because you can suggest changes to the whole paragraph in one go. When anything in this paragraph changes, GitHub will highlight which words changed.
This is a paragraph all on one line. This paragraph is easy to edit because you can suggest changes to the whole paragraph in one go. When anything in this paragraph changes, GitHub will highlight which words changed.
```
- semantic line breaks
```plain
This pargraph uses semantic line breaks.
This paragraph uses semantic line breaks.
Line breaks are introduced between sentences,
and where appropriate, even within sentences.
This makes it easy to review and edit individual sentences or clauses.
Expand All @@ -93,7 +93,7 @@ This bit of info is serious. If you missed it, bad things could happen.
- reflowed to a fixed maximum line length
```plain
This pargraph is split across multiple lines, but it has been run
This paragraph is split across multiple lines, but it has been run
through the editor's reflow function to a maximum line length. This
makes it difficult to review because most changes to any sentence will
also show the following sentences as changed, and GitHub's word-diff
Expand Down
219 changes: 100 additions & 119 deletions assets/css/bundle.css

Large diffs are not rendered by default.

3 changes: 0 additions & 3 deletions assets/css/marketing.css
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
/*!*********************************************************************************************************************************************************************************************************************!*\
!*** css ./node_modules/css-loader/dist/cjs.js??ruleSet[1].rules[1].use[1]!./node_modules/postcss-loader/dist/cjs.js!./node_modules/sass-loader/dist/cjs.js??ruleSet[1].rules[1].use[3]!./src/scss/_marketing.scss ***!
\*********************************************************************************************************************************************************************************************************************/
/*! tailwindcss v2.2.15 | MIT License | https://tailwindcss.com */

/*! modern-normalize v1.1.0 | MIT License | https://github.com/sindresorhus/modern-normalize */
Expand Down
67 changes: 66 additions & 1 deletion assets/js/bundle.js

Large diffs are not rendered by default.

1 change: 0 additions & 1 deletion assets/js/marketing.js
Original file line number Diff line number Diff line change
@@ -1 +0,0 @@
(()=>{"use strict";var __webpack_modules__={"./src/scss/_marketing.scss":(__unused_webpack_module,__webpack_exports__,__webpack_require__)=>{eval("__webpack_require__.r(__webpack_exports__);\n// extracted by mini-css-extract-plugin\n\n\n//# sourceURL=webpack://theme/./src/scss/_marketing.scss?")},"./src/ts/marketing.ts":(__unused_webpack_module,__webpack_exports__,__webpack_require__)=>{eval('__webpack_require__.r(__webpack_exports__);\n/* harmony import */ var _scss_marketing_scss__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../scss/_marketing.scss */ "./src/scss/_marketing.scss");\n\n\n\n//# sourceURL=webpack://theme/./src/ts/marketing.ts?')}},__webpack_module_cache__={};function __webpack_require__(_){var e=__webpack_module_cache__[_];if(void 0!==e)return e.exports;var r=__webpack_module_cache__[_]={exports:{}};return __webpack_modules__[_](r,r.exports,__webpack_require__),r.exports}__webpack_require__.r=_=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(_,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(_,"__esModule",{value:!0})};var __webpack_exports__=__webpack_require__("./src/ts/marketing.ts")})();
3 changes: 2 additions & 1 deletion config/_default/config.yml
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
languageCode: en-us
title: Pulumi - Infrastructure as Code in Any Programming Language

refLinksErrorLevel: WARNING
refLinksErrorLevel: ERROR
security:
funcs:
getenv:
- ASSET_BUNDLE_ID
- PULUMI_CONVERT_URL
- PULUMI_AI_WS_URL
- PULUMI_COPILOT_URL
- GITHUB_TOKEN
- ALGOLIA_APP_ID
- ALGOLIA_APP_SEARCH_KEY
Expand Down
4 changes: 1 addition & 3 deletions content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ secrets:
image: /images/product/esc-diagram-octopus.svg
alt: a screenshot of Pulumi ESC
description: |
Easily access, share, and manage environments, secrets, and configurations securely on any cloud using your favorite programming languages. Pull and sync with any secrets store, and consume in any application, tool, or CI/CD platform.
Tame secrets sprawl and configuration complexity securely across all your cloud infrastructure and applications. Pull and sync with any secrets store, and consume in any application, tool, or CI/CD platform.
customer_logos:
title: Trusted by over 3,000 innovative companies
Expand All @@ -62,8 +62,6 @@ customer_logos:
link: /case-studies/
- name: unity
link: /case-studies/
- name: rockstar
link: /case-studies/
- name: deloitte
link: /case-studies/
- name: stokespace
Expand Down
85 changes: 0 additions & 85 deletions content/about/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,89 +45,4 @@ values:
content: As early employees, we are owners and behave accordingly. We are frugal, spend Pulumi’s resources as if they’re our own, and accomplish more with less.
icon: user-tie
color: violet
spotlight:
- id: jonelle-boyd
name: Jonelle Boyd
size: 150
top: 25
left: 0
opacity: 100
- id: sara-huddleston
name: Sara Huddleston
size: 94
top: -28
left: 175
opacity: 100
- id: bryce-lampe
name: Bryce Lampe
size: 94
top: 205
left: 90
opacity: 50
- id: engin-diri
name: Engin Diri
size: 150
top: 196
left: 240
opacity: 100
- id: casey-huang
name: Casey Huang
size: 150
top: 20
left: 345
opacity: 50
- id: monica-rodriguez
name: Monica Rodriguez
size: 94
top: 240
left: 445
opacity: 50
- id: sean-holung
name: Sean Holung
size: 94
top: 30
left: 580
opacity: 100
- id: casie-snyder
name: Casie Snyder
size: 150
top: 150
left: 600
opacity: 100
- id: daniel-bradley
name: Daniel Bradley
size: 94
top: -15
left: 750
opacity: 50
- id: zaid-ajaj
name: Zaid Ajaj
size: 150
top: 125
left: 830
opacity: 50
- id: sarah-hughes
name: Sarah Hughes
size: 94
top: 5
left: 945
opacity: 100
- id: devon-grove
name: Devon Grove
size: 150
top: 48
left: 1115
opacity: 100
- id: christian-nunciato
name: Christian Nunciato
size: 150
top: 235
left: 1050
opacity: 50
- id: james-denyer
name: James Denyer
size: 94
top: 120
left: 1317
opacity: 50
---
Loading

0 comments on commit 5136a2c

Please sign in to comment.