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.

Sign up for GitHub

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

Jump to bottom

Function reference in gitbook documentation #793

Closed
smola opened this issue Apr 10, 2019 · 1 comment · Fixed by #795
Closed

Function reference in gitbook documentation #793

smola opened this issue Apr 10, 2019 · 1 comment · Fixed by #795
Assignees
@erizocosmico
Labels
documentation This is a documentation issue or pull request

Comments

@smola
Copy link
Contributor

smola commented Apr 10, 2019

Current Supported syntax links to go-mysql-server documentation. It reads:

To see the SQL subset currently supported take a look at this list from src-d/go-mysql-server.

I think we should include it right in the gitbook, and specially for the functions, have their signature and some description.
@smola smola added the documentation This is a documentation issue or pull request label Apr 10, 2019
@erizocosmico
Copy link
Contributor

To avoid inconsistencies between them, I suggest the following:

  • Add <!-- TAGS LIKE THIS --> to delimit parts in the readme and some other files in go-mysql-server and gitbase.
  • Replace them with newer versions every time we run make upgrade script.

That way, gitbase always has the content of the version we're running.

@erizocosmico erizocosmico self-assigned this Apr 10, 2019
@erizocosmico erizocosmico mentioned this issue Apr 11, 2019
Closed
erizocosmico added a commit to erizocosmico/gitbase that referenced this issue Apr 11, 2019
@erizocosmico
tools: make upgrade tool copy docs from go-mysql-server
39c1e09 
Fixes src-d#793

There are some docs we want to have in gitbase as well as
go-mysql-server. To avoid possibly having different versions in
each project, this will automatically copy certain parts and files
from one to the other when there is an update.

Signed-off-by: Miguel Molina <miguel@erizocosmi.co>
@erizocosmico erizocosmico mentioned this issue Apr 11, 2019
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@erizocosmico erizocosmico

Labels
documentation This is a documentation issue or pull request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

tools: make upgrade tool copy docs from go-mysql-server erizocosmico/gitbase
2 participants
@smola @erizocosmico