Skip to content

docs: fix broken link, grammar, and typos across documentation #668

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.

Sign up for GitHub

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

Open
sarthakkaushik927 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: fix broken link, grammar, and typos across documentation #668

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ _Text and Images_
- Most page data is stored in `static/data/<page-name>`
- It is set up so that you can use markdown in the strings for much of the content.
- _If the markdown syntax renders, it needs to be passed into the `Markdown` component (in `components/utilities/`)_
- files like `static/data/globa.ts`, `static/data/testimonials.ts`, and `static/data/meetings.ts` are meant to make it easier for people with limited coding experience to be able to quickly update specific and regularly changing content.
- files like `static/data/global.ts`, `static/data/testimonials.ts`, and `static/data/meetings.ts` are meant to make it easier for people with limited coding experience to be able to quickly update specific and regularly changing content.
- **note**: the `papaparse` library has been added for switching to `.csv` files in the future.

### Page Style and Structure
Expand All @@ -79,7 +79,7 @@ _Text and Images_

### Typescript

- a bunch of base types are found in `typs.d.ts`
- a bunch of base types are found in `types.d.ts`
- these are primarily for props. Kept minimal by design and then extended when needed (primarily with style props)

### Assets
Expand All @@ -91,7 +91,7 @@ _Text and Images_
- changes to the default styles are in `src/assets/css/main.css` in the following order:
- imports
- docusaurus root colors
- docusarus component style changes
- docusaurus component style changes
- font configuration
- default fonts are set inside `@layer base{}` in `main.css` using tailwind's **@apply** syntax

Expand Down
6 changes: 3 additions & 3 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The documentation for Podman is located
## Installing Podman

For installing or building Podman, please see the
[installation instructions](docs/installation).
[installation instructions](installation.md).

## Familiarizing yourself with Podman

Expand Down Expand Up @@ -101,7 +101,7 @@ podman ps
### Testing the httpd container

As you are able to see, the container does not have an IP Address assigned. The
container is reachable via it's published port on your local machine.
container is reachable via its published port on your local machine.

```bash
curl http://localhost:8080
Expand Down Expand Up @@ -134,7 +134,7 @@ podman inspect -l | grep IPAddress
**Note**: The `-l` is a convenience argument for **latest container**. Instead of this short argument, you can
also use the container's ID, container's name or the long argument (`--latest`).

**Note**: If you are running remote Podman client, including Mac and Windows
**Note**: If you are running a remote Podman client, including Mac and Windows
(excluding WSL2) machines, the `-l` option is not available.

### Viewing the container's logs
Expand Down
4 changes: 2 additions & 2 deletions docs/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ service running in the Machine VM.
<summary>Use the Installer (Recommended)</summary>

Podman can be downloaded from the [Podman.io](https://podman.io) website.
You can get binaries and a pkginstaller from our [GitHub release page](https://github.com/containers/podman/releases).
You can get binaries and a pkg installer from our [GitHub release page](https://github.com/containers/podman/releases).

</details>

Expand Down Expand Up @@ -95,7 +95,7 @@ For further details, please refer to the instructions on the [Alpine Linux wiki]

#### [CentOS Stream](https://www.centos.org)

Podman is available in the default in the AppStream repo for CentOS Stream 9+.
Podman is available by default in the AppStream repo for CentOS Stream 9+.

```bash
sudo dnf -y install podman
Expand Down