search

balena-io / pensieve

A tool for managing and viewing structured documents, backed by the power of git
7 stars 5 forks source link

Add option to allow public read access to document #61

Open LucianBuzzo opened 7 years ago

LucianBuzzo commented 7 years ago

In the case that the repo is public, we could allow user's to view and filter the document, but not edit it.

LucianBuzzo commented 7 years ago

The issue we will probably hit here is that user's will need to login, otherwise we will quickly hit the GitHub API rate limit for unauthenticated requests.

LucianBuzzo commented 6 years ago

I think the way forward here is to allow create some kind of 'build' functionality to pensieve that will generate a flat, read-only version of the document

sqweelygig commented 6 years ago

sqweelygig at 10:02 I’d actually want it to be read-only, with changes to the documentation happening in-step with changes to the codebase. sqweelygig at 10:03 I only want the really good yml list presenter and filter, don’t actually want the utterly amazing yml editor on this occasion 10:04 lucianbuzzo at 10:08 @sqweelygig, So you want a read-only pensieve? sqweelygig at 10:08 I know, weird right? lucianbuzzo at 10:09 There a lot of strong use cases for a read-only pensieve lucianbuzzo at 10:10 Issue #61: Add option to allow public read access to document by LucianBuzzo in resin-io/pensieve on GitHub lucianbuzzo at 10:11 @sqweelygig, Add your comments to this issue please ^^ 😄 sqweelygig at 10:12 Hubot commands seem intrinsically list-based semi-structured and git-backed already, so having the coder write up a little yml help entry just seems intrinsically great.

sqweelygig commented 6 years ago

I'd really like for penseive to be able to present files in a read-only manner for the documentation in a repo. My ideal use-case would be to have all the penseive yml files moving in step with the codebase, especially because the commands that hubot understands are already so close to penseive friendly already.

alexandrosm commented 6 years ago

@lucianbuzzo -- I think this can happen automatically if the user has "read" but doesn't have "write" access to the repo. As a consequence, public repos should be readable without login. In this way we don't have to build much new at all. If the user doesn't have write access, we don't present "edit" or "save" buttons.

--

Alexandros Marinos

Founder & CEO, Resin.io

+1 206-637-5498

@alexandrosm

On Thu, Dec 14, 2017 at 2:24 AM, Andrew Lucas notifications@github.com wrote:

I'd really like for penseive to be able to present files in a read-only manner for the documentation in a repo. My ideal use-case would be to have all the penseive yml files moving in step with the codebase, especially because the commands that hubot understands are already so close to penseive friendly already.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/resin-io/pensieve/issues/61#issuecomment-351670152, or mute the thread https://github.com/notifications/unsubscribe-auth/ABLUCAtaAaWvWqq71oeH8gOIFtjXW4Dtks5tAPdhgaJpZM4O44M7 .