Skip to content

Commit

Permalink
Merge pull request #12 from LNA-DEV/dev
Browse files Browse the repository at this point in the history
Code Cleanup
  • Loading branch information
LNA-DEV authored Dec 8, 2022
2 parents b0a6d23 + 98e9189 commit a23682a
Show file tree
Hide file tree
Showing 74 changed files with 2 additions and 7,049 deletions.
10 changes: 0 additions & 10 deletions .editorconfig

This file was deleted.

1 change: 0 additions & 1 deletion .nvmrc

This file was deleted.

5 changes: 0 additions & 5 deletions .prettierrc.json

This file was deleted.

17 changes: 0 additions & 17 deletions .run/Hugo.run.xml

This file was deleted.

14 changes: 0 additions & 14 deletions .s3deploy.yml

This file was deleted.

10 changes: 0 additions & 10 deletions .vscode/cspell.json

This file was deleted.

186 changes: 0 additions & 186 deletions CHANGELOG.md

This file was deleted.

62 changes: 1 addition & 61 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,67 +33,7 @@ This project follows

See the [contribution guidelines][] in the Docsy user guide.

## Publishing a release

These notes are WIP for creating a release (v0.X.Y) from a local copy of the
repo.

1. Change directory to your local Docsy repo.
2. Ensure that the [CHANGELOG](CHANGELOG.md) has a release summary entry for
v0.X.Y. If not, create one with a brief summary of breaking changes using
the section template at the end of the file. (Note that change details are
autogenerated by GitHub in a later step.)
3. Update module and package versions:
- Update the version of `docsy/dependencies` in [go.mod](go.mod) to v0.X.Y.
- Update the NPM package version in [package.json](package.json) to 0.X.Y.
4. Update the Docsy `version` in [userguide/config.toml][] to 0.X.Y.
5. Commit your changes, usually as a PR entitled "Release v0.X.Y preparation".
Once the PR is approved and merged, proceed with the remaining steps.
6. Ensure that you're:
- On the default branch
- At the commit that you want to tag as the next release (usually `@HEAD`).
7. Create the tags for v0.X.Y (we currently need two):

```sh
REL=v0.X.Y
git tag $REL
git tag dependencies/$REL
```

8. Push the new tags to the main repo (which is named `upstream` in the
following setup):

```console
$ git push upstream $REL && git push upstream dependencies/$REL
...
* [new tag] v0.X.Y -> v0.X.Y
* [new tag] dependencies/v0.X.Y -> dependencies/v0.X.Y
```

9. Use the GitHub [Draft a new release][] feature, filling in the fields as
follows:

- From the **release/tag dropdown**: Select the new release tag that you
just pushed, v0.X.Y.
- Set the **release title** to the release number (without the "v").
- Click "auto-generate release notes" to get the release details.
- Replace the auto-generated "## What's Changed" heading by the following:

```markdown
## Release summary
See, https://github.com/google/docsy/blob/main/CHANGELOG.md#0XY
## Commit details
```

- Replace the `0XY` anchor target above with a target appropriate for this
release.
- Remove the "New contributors" autogenerated text (if present) since we
don't publish that as part of our release notes.
- Select **Create a discussion for this release**.
- Click **Publish release**.
[//]: # (Vars)

[contribution guidelines]: https://www.docsy.dev/docs/contribution-guidelines/
[Draft a new release]: https://github.com/google/docsy/releases/new
[userguide/config.toml]: userguide/config.toml
10 changes: 0 additions & 10 deletions Dockerfile

This file was deleted.

14 changes: 0 additions & 14 deletions docker-compose.yaml

This file was deleted.

13 changes: 0 additions & 13 deletions netlify.toml

This file was deleted.

2 changes: 1 addition & 1 deletion theme.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "PrivateDocsy"
license = "Apache 2.0"
licenselink = "https://github.com/LNA-DEV/PrivateDocsy/blob/main/LICENSE"
description = "A Hugo theme for technical documentation sites"
description = "A Hugo theme for technical documentation sites. Forked from Google but focused on privacy."
homepage = "https://docsy.dev"
tags = ["documentation", "multilingual", "customizable", "responsive", "docs", "privacy"]
features = []
Expand Down
5 changes: 0 additions & 5 deletions userguide/.gitignore

This file was deleted.

8 changes: 0 additions & 8 deletions userguide/.htmltest.yml

This file was deleted.

Loading

0 comments on commit a23682a

Please sign in to comment.