Skip to content

Commit

Permalink
website: fix usages of img tag (#14910)
Browse files Browse the repository at this point in the history
* fix usages of img tag and integrate dev-portal workflows

* Adjust Makefile
  • Loading branch information
Bryce Kalow authored and thiskevinwang committed Apr 25, 2022
1 parent 4736abc commit 8d2bd15
Show file tree
Hide file tree
Showing 57 changed files with 23,986 additions and 16,630 deletions.
1,789 changes: 871 additions & 918 deletions .circleci/config.yml

Large diffs are not rendered by default.

14 changes: 0 additions & 14 deletions .circleci/config/jobs/algolia-index.yml

This file was deleted.

22 changes: 0 additions & 22 deletions .circleci/config/jobs/website-docker-image.yml

This file was deleted.

15 changes: 3 additions & 12 deletions .circleci/config/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,15 +37,6 @@ jobs:
- test-go-race-remote-docker:
requires:
- pre-flight-checks
- website-docker-image:
context: vault-docs
filters:
branches:
only:
- main
- algolia-index:
context: vault-docs
filters:
branches:
only:
- stable-website
- semgrep:
requires:
- pre-flight-checks
17 changes: 10 additions & 7 deletions website/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Vault Website

This subdirectory contains the entire source for the [Vault Website](https://vaultproject.io/). This is a [NextJS](https://nextjs.org/) project, which builds a static site from these source files.
This subdirectory contains the content for the [Vault Website](https://vaultproject.io/).

<!--
This readme file contains several blocks of generated text, to make it easier to share common information
Expand Down Expand Up @@ -40,6 +40,10 @@ The website can be run locally through node.js or [Docker](https://www.docker.co

> **Note:** If you are using a text editor that uses a "safe write" save style such as **vim** or **goland**, this can cause issues with the live reload in development. If you turn off safe write, this should solve the problem. In vim, this can be done by running `:set backupcopy=yes`. In goland, search the settings for "safe write" and turn that setting off.
| :warning: WARNING :warning: |
| :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| If you've previously run the website successfully using either the Docker or Node.js approach but are now facing some issue then try `docker rmi $(docker images -aq hashicorp-vault-website-local) && make build-image && make website-local` or `rm -rf node_modules`; failing that consider cloning this repository again and re-attempting the steps anew in a clean clone. |

### With Docker

Running the site locally is simple. Provided you have Docker installed, clone this repo, run `make`, and then visit `http://localhost:3000`.
Expand Down Expand Up @@ -77,7 +81,6 @@ This file can be standard Markdown and also supports [YAML frontmatter](https://
title: 'My Title'
description: "A thorough, yet succinct description of the page's contents"
---

```

The significant keys in the YAML frontmatter are:
Expand All @@ -100,7 +103,7 @@ There are several custom markdown plugins that are available by default that enh
- If you see `# Headline ((#slug))`, this is an example of an [anchor link alias](https://github.com/hashicorp/remark-plugins/tree/je.anchor-link-adjustments/plugins/anchor-links#anchor-link-aliases). It adds an extra permalink to a headline for compatibility and is removed from the output.
- Due to [automatically generated permalinks](https://github.com/hashicorp/remark-plugins/tree/je.anchor-link-adjustments/plugins/anchor-links#anchor-links), any text changes to _headlines_ or _list items that begin with inline code_ can and will break existing permalinks. Be very cautious when changing either of these two text items.

Headlines are fairly self-explanitory, but here's an example of how list items that begin with inline code look.
Headlines are fairly self-explanatory, but here's an example of how list items that begin with inline code look.

```markdown
- this is a normal list item
Expand All @@ -126,7 +129,7 @@ The `Tabs` component creates tabbed content of any type, but is often used for c

![Tabs Component](https://p176.p0.n0.cdn.getcloudapp.com/items/WnubALZ4/Screen%20Recording%202020-06-11%20at%2006.03%20PM.gif?v=1de81ea720a8cc8ade83ca64fb0b9edd)

> Please refer to the [Swingset](https://react-components.vercel.app/?component=Tabs) documention for the latest examples and API reference.
> Please refer to the [Swingset](https://react-components.vercel.app/?component=Tabs) documentation for the latest examples and API reference.

It can be used as such within a markdown file:

Expand All @@ -150,7 +153,7 @@ $ curl ...
</Tab>
</Tabs>

Contined normal markdown content
Continued normal markdown content
````
The intentionally skipped line is a limitation of the mdx parser which is being actively worked on. All tabs must have a heading, and there is no limit to the number of tabs, though it is recommended to go for a maximum of three or four.
Expand Down Expand Up @@ -404,7 +407,7 @@ This configuration would display something like the following text on the websit
A {{ release candidate }} for <Product> {{ v1.0.0 }} is available! The release can be <a href='https://releases.hashicorp.com/<product>/{{ 1.0.0-rc1 }}'>downloaded here</a>.
```
You may customize the parameters in any way you'd like. To remove a prerelease from the website, simply delete the `prerelease` paremeter from the above component.
You may customize the parameters in any way you'd like. To remove a prerelease from the website, simply delete the `prerelease` parameter from the above component.
<!-- END: releases -->
Expand Down Expand Up @@ -448,7 +451,7 @@ One more example - let's say that content is being moved to an external website.
}
```
If we no longer want the link to be in the side nav, we can simply remove it. If we do still want the link in the side nav, but pointing to an external destnation, we need to slightly change the structure as such:
If we no longer want the link to be in the side nav, we can simply remove it. If we do still want the link in the side nav, but pointing to an external destination, we need to slightly change the structure as such:
```js
{
Expand Down
13 changes: 0 additions & 13 deletions website/components/before-after-diagram/fragment.graphql

This file was deleted.

87 changes: 0 additions & 87 deletions website/components/before-after-diagram/index.jsx

This file was deleted.

31 changes: 0 additions & 31 deletions website/components/before-after-diagram/server.js

This file was deleted.

Loading

0 comments on commit 8d2bd15

Please sign in to comment.