Skip to content
This repository has been archived by the owner on Nov 9, 2017. It is now read-only.

Add Read the docs documentation. #44

Merged
merged 1 commit into from
Jan 19, 2015
Merged

Conversation

carlosmunoz
Copy link
Member

Currently uses the default readthedocs theme, but can be customized with our own theme. This is an almost exact copy of the content on zanata.org/help that relates to the client.

Currently uses the default readthedocs theme, but can be customized with our own theme. This is an almost exact copy of the content on zanata.org/help that relates to the client.
@carlosmunoz
Copy link
Member Author

@seanf @lukebrooker Do you guys mind taking a look at this?
A draft build of this Pull Request can be seen at http://zanata-client.readthedocs.org/en/readthedocs/

@seanf
Copy link
Contributor

seanf commented Jan 16, 2015

@carlosmunoz Shouldn't that be something like http://zanata-client.readthedocs.org/en/latest/readthedocs/ so that we can have different versions? (I know, it's just a draft.)

@seanf
Copy link
Contributor

seanf commented Jan 16, 2015

@carlosmunoz oh, readthedocs is a version. (?!) You got me!

@carlosmunoz
Copy link
Member Author

Yes 😄 , just a placeholder for the time being, once it's on master I was thinking:
master => latest
release => stable
A few (?) previous releases for reference.

@seanf
Copy link
Contributor

seanf commented Jan 16, 2015

@carlosmunoz Is there a limit on the number of releases?

@seanf
Copy link
Contributor

seanf commented Jan 16, 2015

@carlosmunoz
Can we make "Edit on GitHub" link to the actual file?
The issue tracker link is not clickable. Is the main page new content, or was it taken from zanata.org/help somewhere?

@carlosmunoz
Copy link
Member Author

Answers:

  1. We could point it to the actual file, but we have to build our own custom template.
  2. Main page content is a placeholder, we should edit.
  3. There doesn't seem to be a limit, you can specify how many major, minor and point versions you want to keep.

@seanf
Copy link
Contributor

seanf commented Jan 16, 2015

We might want to find a way of disabling syntax highlighting for some of the sample console output in the docs.

@carlosmunoz
Copy link
Member Author

Which one for example?

@carlosmunoz
Copy link
Member Author

Never mind, found it.

@seanf
Copy link
Contributor

seanf commented Jan 16, 2015

@carlosmunoz Regarding "Edit on GitHub", perhaps we could just link to https://github.com/zanata/zanata-client/tree/master/docs (the subdirectory)

@carlosmunoz
Copy link
Member Author

@seanf Sure thing.

@seanf
Copy link
Contributor

seanf commented Jan 16, 2015

@carlosmunoz It looks like a great start. I like the side menu. But the search feature doesn't seem to work very well - searching for zanata.xml doesn't give many results.

carlosmunoz added a commit that referenced this pull request Jan 19, 2015
Add Read the docs documentation.
@carlosmunoz carlosmunoz merged commit abb8fcd into integration/master Jan 19, 2015
@carlosmunoz carlosmunoz deleted the readthedocs branch January 19, 2015 01:36
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
2 participants