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

Docs overhaul #1954

Merged
merged 6 commits into from Apr 23, 2024
Merged

Docs overhaul #1954

merged 6 commits into from Apr 23, 2024

Conversation

matt0x6F
Copy link
Contributor

@matt0x6F matt0x6F commented Apr 21, 2024

What is the problem I am trying to address?

The documentation site used a very old version of Hugo and an abandoned theme, had outdated information, and dead links.

How is the fix applied?

Hugo is upgraded to a modern version, the reboot of the original theme is used, and links are replaced or removed. Additionally, the readme is updated to state our utility in the first sentence.

Note: References to vGo and other since abandoned terminology has been replaced with Go's newer terminology and references.

What GitHub issue(s) does this PR fix or close?

Fixes #1953
Closes #1951

@matt0x6F matt0x6F added the docs improvements/changes to our documentation label Apr 21, 2024
@matt0x6F matt0x6F self-assigned this Apr 21, 2024
@matt0x6F matt0x6F requested a review from a team as a code owner April 21, 2024 18:36
@matt0x6F
Copy link
Contributor Author

I'm not sure why Netlify believes the theme directory is a submodule: https://app.netlify.com/sites/gomods-athens/deploys/66255cb2e30cf700085dcd63

@matt0x6F
Copy link
Contributor Author

Okay, well looks like I had accidentally checked in the themes .git directory and it hosed everything briefly. Should be all good now.

@matt0x6F
Copy link
Contributor Author

Preview here

@matt0x6F matt0x6F enabled auto-merge (squash) April 21, 2024 21:48
@matt0x6F matt0x6F merged commit c35b50f into gomods:main Apr 23, 2024
11 checks passed
@matt0x6F matt0x6F deleted the docs-overhaul branch April 23, 2024 06:16
DrPsychick added a commit to gomods/athens-charts that referenced this pull request May 2, 2024
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Update | Change |
|---|---|---|
| [gomods/athens](https://togithub.com/gomods/athens) | minor |
`v0.13.3` -> `v0.14.0` |

---

### Release Notes

<details>
<summary>gomods/athens (gomods/athens)</summary>

### [`v0.14.0`](https://togithub.com/gomods/athens/releases/tag/v0.14.0)

[Compare
Source](https://togithub.com/gomods/athens/compare/v0.13.3...v0.14.0)

#### What's Changed

- update-go-pkg(deps): bump github.com/aws/aws-sdk-go from 1.44.220 to
1.51.21 by [@&#8203;dependabot](https://togithub.com/dependabot) in
[gomods/athens#1942
- Add an introduction page as the home page by
[@&#8203;matt0x6F](https://togithub.com/matt0x6F) in
[gomods/athens#1945
- build(deps): bump golang.org/x/net from 0.22.0 to 0.23.0 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[gomods/athens#1946
- Add logging configuration docs by
[@&#8203;matt0x6F](https://togithub.com/matt0x6F) in
[gomods/athens#1952
- Docs overhaul by [@&#8203;matt0x6F](https://togithub.com/matt0x6F) in
[gomods/athens#1954
- Upgrade to AWS SDK v2
([#&#8203;1938](https://togithub.com/gomods/athens/issues/1938)) by
[@&#8203;nesangcode](https://togithub.com/nesangcode) in
[gomods/athens#1950
- update-github-action(deps): bump golangci/golangci-lint-action from 4
to 5 by [@&#8203;dependabot](https://togithub.com/dependabot) in
[gomods/athens#1956
- Bump
go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc
from 0.25.0 to 0.46.0 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[gomods/athens#1901
- update-go-pkg(deps): bump github.com/unrolled/secure from
0.0.0-20181221173256-0d6b5bb13069 to 1.14.0 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[gomods/athens#1955

#### New Contributors

- [@&#8203;nesangcode](https://togithub.com/nesangcode) made their first
contribution in
[gomods/athens#1950

**Full Changelog**:
gomods/athens@v0.13.3...v0.14.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/gomods/athens-charts).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4zMzEuMCIsInVwZGF0ZWRJblZlciI6IjM3LjMzMS4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6W119-->

---------

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: DrPsychick <drpsychick@drsick.net>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs improvements/changes to our documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve the readme Retheme the docs site
2 participants