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

website: no godoc for non-pkg packages #1010

Closed
bradfitz opened this issue Jan 3, 2018 · 3 comments
Closed

website: no godoc for non-pkg packages #1010

bradfitz opened this issue Jan 3, 2018 · 3 comments

Comments

@bradfitz
Copy link
Contributor

bradfitz commented Jan 3, 2018

We serve godoc for e.g.

But not for other packages, like internal:

https://perkeep.org/internal/lru

Which also means people can't go get it.

Now, internal doesn't matter much, because people can't go get it anyway, but web-based docs would be nice.

And if we continue to move everything out of perkeep.org/pkg/* up a level, we'll need to resolve this more generally.

/cc @willnorris @mpl

@bradfitz
Copy link
Contributor Author

bradfitz commented Jan 3, 2018

Note that https://godoc.org/perkeep.org/internal/lru works at least.

@willnorris
Copy link
Member

That's easy enough to fix, as long as we're reasonably sure we won't have other website content that would conflict. I've only seen pkg/* packages move into internal so far. So to clarify, the plan for the others is to just move it up to the top-level? There's little enough actual website top-level content that avoiding conflicts shouldn't be too hard.

@bradfitz
Copy link
Contributor Author

bradfitz commented Jan 3, 2018

So to clarify, the plan for the others is to just move it up to the top-level?

I think so. I don't think there will be too many once pkg is cleaned up. We'll have perkeep.org/blob and perkeep.org/importer/* and perkeep.org/blobserver/* etc.

We'll just have to make sure docs on the website are under /doc/ instead of putting docs at the top-level that might conflict with package names.

@willnorris willnorris self-assigned this Jan 5, 2018
camlistorebot pushed a commit that referenced this issue Jan 6, 2018
this is a straight revert of 0293828 plus the additional logic to
derive the domain name from the serving directory. This allows package
docs to also be served from localhost during development.

Updates #1010

Change-Id: I07f817edb0b83b03e363373945d143ed3cb82fbf
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants