Skip to content
This repository has been archived by the owner on May 24, 2023. It is now read-only.

add a linkable section of frequently encountered errors #15

Closed
arnehormann opened this issue Nov 22, 2013 · 13 comments
Closed

add a linkable section of frequently encountered errors #15

arnehormann opened this issue Nov 22, 2013 · 13 comments

Comments

@arnehormann
Copy link
Contributor

Could you help us out by adding a linkable section with frequently encountered problems to the database tutorial?
I'd really love to have a bunch of short linkable answers ready when closing issues for the mysql driver - but I lack the experience in technical writing (and am not a native speaker).

What I have in mind is a way to quickly answer and close issues like
"SELECT ? does not work with a slice".

@xaprb
Copy link
Contributor

xaprb commented Nov 22, 2013

Hmmmm... you know, we might be kind of overloading the README's capabilities. Because linkable things are going to be linked with # targets in the URL, which is not easy for you. But we could split it up and make a bunch of markdown files and serve them with github pages, which could be easier to organize. I am happy to do that -- turn a repo into a proper site, I mean. How do you feel about that?

Thank you for suggesting this, and I think it's a great idea.

@arnehormann
Copy link
Contributor Author

I believe every header is linkable. Hover over it and it shows a link
symbol to its left, click it and you have the link. Works at least down to
h2.

Here's an example: https://github.com/VividCortex/go-database-sql-tutorial#common-database-operations

Am 22.11.2013 15:48 schrieb "Baron Schwartz" notifications@github.com:

Hmmmm... you know, we might be kind of overloading the README's
capabilities. Because linkable things are going to be linked with # targets
in the URL, which is not easy for you. But we could split it up and make a
bunch of markdown files and serve them with github pages, which could be
easier to organize. I am happy to do that -- turn a repo into a proper
site, I mean. How do you feel about that?

Thank you for suggesting this, and I think it's a great idea.


Reply to this email directly or view it on GitHubhttps://github.com//issues/15#issuecomment-29077415
.

@arnehormann
Copy link
Contributor Author

On the other hand... having a github pages site enables granular updates and reduces merge conflicts if it takes off and more collaborators join in. And the added control over the content is probably neat, too.
Yes, I'd prefer the github-pages approach. Wouldn't have dared to suggest it myself, though...

@xaprb
Copy link
Contributor

xaprb commented Nov 22, 2013

I actually have zero experience with a github pages site, but I can't
believe it is hard to do :-) I'll look into it, and any help is welcome!
I'll post on Google+ about it and see if someone wants to jump in to make
it happen, too.

@xaprb
Copy link
Contributor

xaprb commented Nov 22, 2013

I've just set up a custom domain and created the site (with default content, with their auto-create tool to get started) at https://github.com/VividCortex/go-database-sql-tutorial/tree/gh-pages. The domain is go-database-sql.org. It will probably take a few minutes for this all to activate.

@arnehormann
Copy link
Contributor Author

Great!!! 👍

@xaprb
Copy link
Contributor

xaprb commented Nov 22, 2013

It would be great to submit this to the Go Advent Calendar when it's done... https://groups.google.com/forum/#!msg/golang-nuts/UlSPVQDo-rc/jHbtK8DbxOMJ

@xaprb
Copy link
Contributor

xaprb commented Nov 22, 2013

@arnehormann I've created a new team with push/pull access to this repo, and added you to that team. Feel free to make changes directly. Hooray! :)

@arnehormann
Copy link
Contributor Author

I will definitely do so in the future - esp. extending it based on bug reports we get.
Will you (please? 😀) do the initial setup, basic structuring and the conversion to the github pages format?
That's actually what I'm shying away from, otherwise I'd have started with a PR and not with an issue...

@xaprb
Copy link
Contributor

xaprb commented Nov 22, 2013

Hah, yeah, I'm just figuring out that Github filled my default Pages with
HTML and templates -- I thought it was all going to be Jekyll stuff by
default, so now I guess I'd better learn a little Jekyll and see if I can
get this train on the tracks again :-)

@xaprb
Copy link
Contributor

xaprb commented Nov 25, 2013

http://go-database-sql.org/ is live. I've pretty much copy/pasted the current content into it. I think it needs to be restructured, but it's a start. To edit it, switch to the gh-pages branch and just modify any of the .md files.

@xaprb
Copy link
Contributor

xaprb commented Nov 29, 2013

I've restructured it. I'll now look through the other contributions you added, but I'll close this issue.

@xaprb xaprb closed this as completed Nov 29, 2013
@arnehormann
Copy link
Contributor Author

Thanks!

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

2 participants