| Commit message (Collapse) | Author | Files |
|---|
|
feat: Allow packages to define custom doc URL and badge
Co-authored-by: Jacob Oaks <jacoboaks.8@gmail.com>
Co-authored-by: r-hang <rhang@uber.com>
|
|
* Support dark mode theme
* Add dark mode to 404 and package pages
* Fix tests
|
|
Adds a `-templates` flag that can be used to provide
an alternative directory with templates for Sally to use.
The new templates override the default set embedded in Sally.
This includes a new 404 template so that 404 errors
use the same theme as the rest of the website.
Additionally, for HTTP status >400,
this also sets the Cache-Control header
to discourage CDNs like Cloudflare from caching the page.
Resolves #125, #18
|
|
Adds support to other VCS systems as per the specification.
Defaults to `git` for backwards compatibility.
Renames the internally used `.GitURL` to `.RepoURL` for clarity.
|
|
Fixes the documentation URL in the homepage, as it already includes the protocol:
https://github.com/uber-go/sally/blob/686fb8782cfa89a807ecc6dcbc104c6dab43eb66/handler.go#L45
Right now, we're rendering "https://https://[...]".
|
|
<details>
<summary>Background</summary>
Sally renders two kinds of pages:
- packages: These are for packages defined in sally.yaml
and any route under the package path.
- indexes: These list available packages.
The latter--indexes was previously only supported at '/', the root page.
This leads to a slight UX issue:
if you have a package with a / in its name (e.g. net/metrics):
- example.com/net/metrics gives you the package page
- example.com/ lists net/metrics
- However, example.com/net fails with a 404
</details>
This adds support for index pages on all parents of package pages.
Therefore, if example.com/net/metrics exists,
example.com/net will list all packages defined under that path.
Resolves #31
|
|
* update: removing redundant go-source tag
* fix: removing /.idea and adding dir to gitignore
* fix: removing /.idea and removing branch field from from templateData
* fix: pkgHndler defaultBranch rem revert
* fix: minor typo
* fix: removing assertion of template responses
* fix: tabs
* Update handler_test.go
* Update handler_test.go
* Update handler_test.go
---------
Co-authored-by: Anuragkillswitch <70265851+Anuragkillswitch@users.noreply.github.com>
|
|
Fixes up the `make lint` target to also check
that all files are properly gofmt-ed,
replaces the deprecated `golint` check with `revive`,
and sets up dependabot to also update tools and actions regularly.
|
|
Similar to the previous patch,
this patch removes knowledge of the configuration from the index handler.
Instead, the index handler is now passed a list of packageInfo structs
each containing just the information needed to render the index page.
This also obviates the need to duplicate the logic to compute
the package import path in the index.html template.
|
|
* template: Use a more fluid layout
Instead of using a table, take advantage of the grid layout.
We still print a table of sorts,
but it's more fluid in appearance based on width of the screen.
On narrower screens, we'll show a listing
where each item has a description label next to it
rather than at the top.
* Add support for package descrpitions
Packages may now optionally specify a description.
If specified, this is printed below the package information,
indented one column to make it stand out.
Co-authored-by: Sung Yoon Whang <sungyoonwhang@gmail.com>
|
|
Instead of using a table, take advantage of the grid layout.
We still print a table of sorts,
but it's more fluid in appearance based on width of the screen.
On narrower screens, we'll show a listing
where each item has a description label next to it
rather than at the top.
|
|
This updates sally to build and test against Go 1.19.
Additionally, this upgrades the GitHub Action versions
for checkout and setup-go.
One of the features in setup-go v3 is that caching is built-in
and opted-into with `cache: true`.
Non-CI changes: gofmt, drop ioutil
|
|
When we originally switched to pkg.go.dev (#40),
it did not offer documentation badges so we relied on a third-party
service.
That's no longer true (https://pkg.go.dev/badge) so we can use
pkg.go.dev's more "on-brand" badges for this.
|
|
Update all dependencies,
use Go 1.18 to build and test,
and delete outdated `bindata` clause in Makefile
(we switched to `go:embed` in #50).
Other minor changes:
- Fix the golint import path
(it switched to golang.org/x/lint long before it was deprecated)
and fix the failing lint check.
(Switching from golint to revive is out of scope for this PR.)
- Delete .envrc -- this was transitional for when Go modules were
optional.
|
|
Sally accepts the base vanity URL (e.g. `go.uber.org`) in a top-level
`url` key. This applies to all packages listed in the configuration.
Add support for overriding the `url` on a per-package basis.
This will provide for an easier transition period when migrating Go
packages of an organization between hosts, for example from BitBucket
to GitHub.
With this, source code can be modified across the various
repositories over time to use the new vanity URL. For example, some
packages will use a URL of bitbucketurl.org and some will use
mycoolgoimportvanity.org in their source code imports.
Other than the use-case outlined above, this feature adds flexibility
to the vanity server to support more than one vanity URL when used
behind an ingress controller.
|
|
Go 1.16 includes a `//go:embed` directive that obviates the need for
bindata. Use `//go:embed` instead of bindata for templates used in
sally.
Signed-off-by: Luciano Nooijen <luciano@bytecode.nl>
Co-authored-by: Abhinav Gupta <abg@uber.com>
|
|
Support specifying the branch from which source will be served in
the YAML configuration.
|
|
pkg.go.dev does not serve a badge like godoc.org. This change switches
the image over to one provided by shields.io.
Note that this uses the style "for-the-badge" from shields.io.
|
|
This adds the ability to change the godoc.org instance used by Sally to
link to documentation by providing a new `godoc` section in the
configuration.
|
|
|
|
|
|
|
