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

Permanent storage of instructions for checking artifacts #31

Closed
rando2 opened this issue Mar 24, 2020 · 2 comments
Closed

Permanent storage of instructions for checking artifacts #31

rando2 opened this issue Mar 24, 2020 · 2 comments
Labels
Technical Technical concerns, enhancements, etc. for the GitHub enthusiasts

Comments

@rando2
Copy link
Collaborator

rando2 commented Mar 24, 2020

@cgreene since we don't have AppVeyor notifications linking directly to artifacts and GitHub Actions comments are still being explored (manubot/rootstock#322), we should stick your screenshots and instructions above somewhere permanent. They'll be very helpful for pull request reviewers.

Do we have / want a Wiki for this?

Originally posted by @agitter and @mprobson in #23 (comment)

@rando2 rando2 added the Technical Technical concerns, enhancements, etc. for the GitHub enthusiasts label Mar 24, 2020
@rando2
Copy link
Collaborator Author

rando2 commented Mar 24, 2020

I agree with this line of thinking. I know @cgreene has successfully done it within a repository in the past, but a wiki might not be a bad idea just because it's a bit more of a familiar format for people across fields.

We may also want screenshots of exactly how editing a page (e.g., here is the pencil), proposing a branch, and making a PR will look to reduce barrier to entry for new users. I'd probably say we should do this showing how to add yourself to the metadata -- most of the contributors have not done that, so there seems to be some reservation.

I'm not sure whether we'll need this for issues as well, or if that is similar enough to other media that the barrier to entry isn't as bad.

I'm happy to put together a PR for the intro stuff but wanted to open a discussion about format in line with @agitter & @mprobson 's discussion above.

@cgreene
Copy link
Member

cgreene commented Mar 24, 2020

I have no strong feelings on this, but I agree that having it somewhere would be helpful. I tend to prefer the readme for "broadcast" instructions since it's the first thing folks see when they show up, but if folks are more comfortable with a wiki that's fine too. :)

cgreene added a commit that referenced this issue Mar 26, 2020
Add artifacts instructions, close #31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Technical Technical concerns, enhancements, etc. for the GitHub enthusiasts
Projects
None yet
Development

No branches or pull requests

2 participants