Skip to content
This repository has been archived by the owner on Jul 12, 2018. It is now read-only.

User Story! #45

Closed
wslack opened this issue Aug 28, 2015 · 1 comment
Closed

User Story! #45

wslack opened this issue Aug 28, 2015 · 1 comment

Comments

@wslack
Copy link
Member

wslack commented Aug 28, 2015

Start at https://pages.18f.gov/guides/, see the link, go to the link to the template.

On https://pages.18f.gov/guides-template/, most of the stuff in the introduction doesn't make sense to me. Do I need to know it? It's also confusing why there are so many instructions to update an existing guide (unless the issue is that old guides don't have the new fancy stuff). In any case, I see that I should go to the Readme and go there!

On https://github.com/18F/guides-template/blob/18f-pages/README.md, is there a way to check if I have Ruby? (Will knows he has Ruby , is not sure if others will). It's also not clear if I can do the same by forking the repo on GitHub - will that work? (Discussion ensued on Slack, this is addressed later in the process but an update to instructions might be helpful?)

(Run the brew commands, get slightly freaked out by the number of edited formulas)

Hit an error when trying to clone, #42 addresses this.

I think access Localhost and am a little confused that I am now supposed to work down the side lists (vs "updating an existing guide" - I wonder if that is the next step since my guide exists. However, I figure it out and start working my way down the lieft hand columns

https://pages.18f.gov/guides-template/adding-a-new-page/ is not newbie friendly, but I think that's ok given the fact that this isn't a training on "how to work a GitHub repo". I do just fine.

https://pages.18f.gov/guides-template/updating-the-config-file/ is slightly confusing because the "Once you're finished updating the config file, click the GitHub Setup entry in the table of contents." text is above everything else. I'll submit a PR to clarify that: #44

Also on that page, I am not sure what the description of my repo should be (also, at that point, I might not know the URL). Maybe add a note that explains that the user can some back to this after publishing on GitHub, or to use their repo's name as the root?

I also think we should add instructions to modify the "back link" if appropriate since this should fall under 18F Pages, not 18F Guides. And, the Google Analytics link was already set - can that instruction be removed?

On https://pages.18f.gov/guides-template/updating-the-config-file/understanding-baseurl/, it's not clear me when this should come up - when I'm creating new pages? I haven't made a new page yet, so this is confusing.

On https://pages.18f.gov/guides-template/github-setup/, same issue as config file - the top bit is a bit clearer though. I think the command to run ./go create_repo is confusing because I thought I already had a repo....oh, now I see in doing it that it creates a whole new one! Neat!

As I create my new repo, I don't know if I should edit .gitignore or "add a license." I will assume not. I make the new repo an ignore the instructions (that part isn't quite clear, that I can ignore everything on that page)

Everything works great for putting the repo on the 18F org and adding the webhook. I make some local changes (and run into an issue where I don't have a contributing.md file - Mike B is fixing in #46). I also delete most of the content on index.md and push a commit up using GitHub for Mac! It all worked!

mbland pushed a commit that referenced this issue Aug 28, 2015
wslack added a commit that referenced this issue Aug 28, 2015
@wslack
Copy link
Member Author

wslack commented Aug 28, 2015

Merged and resolved!

@wslack wslack closed this as completed Aug 28, 2015
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant