Skip to content

Commit

Permalink
Merge pull request #33 from sonatype-nexus-community/feat/rename-repo
Browse files Browse the repository at this point in the history
feat: support renaming of this repo to `contribute.sonatype.com`
  • Loading branch information
eddie-knight authored Oct 16, 2024
2 parents de19448 + 13b56f2 commit 98d007c
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 28 deletions.
69 changes: 45 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,26 @@
# Sonatype Open Source Community Handbook

<!-- Badges Section -->

[![shield_gh-workflow-test]][link_gh-workflow-test]
[![shield_license]][license_file]
[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=sonatype-nexus-community_community-handbook.sonatype.com&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=sonatype-nexus-community_community-handbook.sonatype.com)
[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=sonatype-nexus-community_contribute.sonatype.com&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=sonatype-nexus-community_contribute.sonatype.com)

<!-- Add other badges or shields as appropriate -->

---

This repository contains the source for our Sonatype Open Source Community Handbook - the published version can be viewed [here](https://sonatype-nexus-community.github.io/community-handbook.sonatype.com/).
This repository contains the source for our Sonatype Open Source Community
Handbook - the published version can be viewed
[here](https://sonatype-nexus-community.github.io/contribute.sonatype.com/).

This project is based from [Docsy for Hugo](https://www.docsy.dev/docs/get-started/docsy-as-module/installation-prerequisites/#install-hugo).
This project is based from
[Docsy for Hugo](https://www.docsy.dev/docs/get-started/docsy-as-module/installation-prerequisites/#install-hugo).

- [Usage](#usage)
- [Prerequisite Tools](#prerequisite-tools)
- [Running the website locally](#running-the-website-locally)
- [Running a container locally](#running-a-container-locally)
- [Development](#development)
- [The Fine Print](#the-fine-print)

Expand All @@ -23,30 +29,32 @@ This project is based from [Docsy for Hugo](https://www.docsy.dev/docs/get-start
### Prerequisite Tools

You'll need the following tools installed locally for development:

- [Hugo Extended](https://gohugo.io) (>=0.128.0)
- NPM
- NPM

You can find out more about how to install Hugo for your environment in our
[Getting started](https://www.docsy.dev/docs/getting-started/#prerequisites-and-installation) guide.
[Getting started](https://www.docsy.dev/docs/getting-started/#prerequisites-and-installation)
guide.

### Running the website locally

Ensure `npm install` has been run - this ensures `PostCSS` is installed.

Once you've made your working copy of the site repo, from the repo root folder, run:
Once you've made your working copy of the site repo, from the repo root folder,
run:

```bash
hugo server
```

### Running a container locally

You can run docsy-example inside a [Docker](https://docs.docker.com/)
container, the container runs with a volume bound to the `docsy-example`
folder. This approach doesn't require you to install any dependencies other
than [Docker Desktop](https://www.docker.com/products/docker-desktop) on
Windows and Mac, and [Docker Compose](https://docs.docker.com/compose/install/)
on Linux.
You can run docsy-example inside a [Docker](https://docs.docker.com/) container,
the container runs with a volume bound to the `docsy-example` folder. This
approach doesn't require you to install any dependencies other than
[Docker Desktop](https://www.docker.com/products/docker-desktop) on Windows and
Mac, and [Docker Compose](https://docs.docker.com/compose/install/) on Linux.

1. Build the docker image

Expand All @@ -64,10 +72,10 @@ on Linux.

1. Verify that the service is working.

Open your web browser and type `http://localhost:1313` in your navigation bar,
This opens a local instance of the docsy-example homepage. You can now make
changes to the docsy example and those changes will immediately show up in your
browser after you save.
Open your web browser and type `http://localhost:1313` in your navigation
bar, This opens a local instance of the docsy-example homepage. You can now
make changes to the docsy example and those changes will immediately show up
in your browser after you save.

## Development

Expand All @@ -77,17 +85,30 @@ See [CONTRIBUTING.md](./CONTRIBUTING.md) for details.

Remember:

This project is part of the [Sonatype Nexus Community](https://github.com/sonatype-nexus-community) organization, which is not officially supported by Sonatype. Please review the latest pull requests, issues, and commits to understand this project's readiness for contribution and use.
This project is part of the
[Sonatype Nexus Community](https://github.com/sonatype-nexus-community)
organization, which is not officially supported by Sonatype. Please review the
latest pull requests, issues, and commits to understand this project's readiness
for contribution and use.
* File suggestions and requests on this repo through GitHub Issues, so that the community can pitch in
* Use or contribute to this project according to your organization's policies and your own risk tolerance
* Don't file Sonatype support tickets related to this project— it won't reach the right people that way
- File suggestions and requests on this repo through GitHub Issues, so that the
community can pitch in
- Use or contribute to this project according to your organization's policies
and your own risk tolerance
- Don't file Sonatype support tickets related to this project— it won't reach
the right people that way

Last but not least of all - have fun!

<!-- Links Section -->
[shield_gh-workflow-test]: https://img.shields.io/github/actions/workflow/status/sonatype-nexus-community/community-handbook.sonatype.com/ci.yaml?branch=main&logo=GitHub&logoColor=white "build"
[shield_license]: https://img.shields.io/github/license/sonatype-nexus-community/community-handbook.sonatype.com?logo=open%20source%20initiative&logoColor=white "license"

[link_gh-workflow-test]: https://github.com/sonatype-nexus-community/community-handbook.sonatype.com/actions/workflows/ci.yaml?query=branch%3Amain
[license_file]: https://github.com/sonatype-nexus-community/community-handbook.sonatype.com/blob/main/LICENSE
[shield_gh-workflow-test]:
https://img.shields.io/github/actions/workflow/status/sonatype-nexus-community/contribute.sonatype.com/ci.yaml?branch=main&logo=GitHub&logoColor=white
'build'
[shield_license]:
https://img.shields.io/github/license/sonatype-nexus-community/contribute.sonatype.com?logo=open%20source%20initiative&logoColor=white
'license'
[link_gh-workflow-test]:
https://github.com/sonatype-nexus-community/contribute.sonatype.com/actions/workflows/ci.yaml?query=branch%3Amain
[license_file]:
https://github.com/sonatype-nexus-community/contribute.sonatype.com/blob/main/LICENSE
8 changes: 4 additions & 4 deletions hugo.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -123,10 +123,10 @@ params:
url_latest_version: https://example.com

# Repository configuration (URLs for in-page links to opening issues and suggesting changes)
github_repo: https://github.com/sonatype-nexus-community/community-handbook.sonatype.com
github_repo: https://github.com/sonatype-nexus-community/contribute.sonatype.com

# An optional link to a related project repo. For example, the sibling repository where your product code lives.
github_project_repo: https://github.com/sonatype-nexus-community/community-handbook.sonatype.com
github_project_repo: https://github.com/sonatype-nexus-community/contribute.sonatype.com

# Specify a value here if your content directory is not in your repo's root directory
# github_subdir: ""
Expand Down Expand Up @@ -169,9 +169,9 @@ params:
enable: true
# The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful).
'yes': >-
Glad to hear it! Please <a href="https://github.com/sonatype-nexus-community/community-handbook.sonatype.com/issues/new">tell us how we can improve</a>.
Glad to hear it! Please <a href="https://github.com/sonatype-nexus-community/contribute.sonatype.com/issues/new">tell us how we can improve</a>.
'no': >-
Sorry to hear that. Please <a href="https://github.com/sonatype-nexus-community/community-handbook.sonatype.com/issues/new">tell us how we can improve</a>.
Sorry to hear that. Please <a href="https://github.com/sonatype-nexus-community/contribute.sonatype.com/issues/new">tell us how we can improve</a>.
# Adds a reading time to the top of each doc.
# If you want this feature, but occasionally need to remove the Reading time from a single page,
Expand Down

0 comments on commit 98d007c

Please sign in to comment.