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

Separate website for each release #3459

Closed
mkonicek opened this Issue Oct 16, 2015 · 13 comments

Comments

Projects
None yet
9 participants
@mkonicek
Contributor

mkonicek commented Oct 16, 2015

People often send pull requests which update both code and /docs which makes sense. However, when the PR is merged, the docs go live immediately but the code is only released in up to 4 weeks. This means the docs are inconsistent with the APIs and CLI commands people get when using React Native.

Here's an idea:

We could have one per release (0.12.1, 0.12.2, ...) but that seems unnecessary.

The website is generated by Travis running the publish.sh script (see travis.yml) .

We could implement this by simply having subfolders in the static generated content: https://github.com/facebook/react-native/tree/gh-pages

@mkonicek

This comment has been minimized.

Show comment
Hide comment
@mkonicek

mkonicek Oct 16, 2015

Contributor

@brentvatne, @ide Would you be interested in working on this?

I'll be available sporadically for about 3 weeks because of a conference and vacation, plan to work on this when I'm back unless someone picks it up.

Contributor

mkonicek commented Oct 16, 2015

@brentvatne, @ide Would you be interested in working on this?

I'll be available sporadically for about 3 weeks because of a conference and vacation, plan to work on this when I'm back unless someone picks it up.

@brentvatne

This comment has been minimized.

Show comment
Hide comment
@brentvatne

brentvatne Oct 16, 2015

Collaborator

I probably won't have time before the conference to do this but I agree that it's very important! This is a great task for someone looking to get their first contribution in. I'll send it out in the newsletter to see if anyone bites! :)

Collaborator

brentvatne commented Oct 16, 2015

I probably won't have time before the conference to do this but I agree that it's very important! This is a great task for someone looking to get their first contribution in. I'll send it out in the newsletter to see if anyone bites! :)

@kevinzzz007

This comment has been minimized.

Show comment
Hide comment
@kevinzzz007

kevinzzz007 Oct 18, 2015

@mkonicek would love to help out, but feel like I am not exactly sure what you meant, could you elaborate and let me know what specifically I can do to help?

@mkonicek would love to help out, but feel like I am not exactly sure what you meant, could you elaborate and let me know what specifically I can do to help?

@brentvatne

This comment has been minimized.

Show comment
Hide comment
@brentvatne

brentvatne Oct 19, 2015

Collaborator

@kevinzzz007 - short version: we want to build a different version of the docs for every tagged release of React Native, and make it possible to switch between those 😄

Collaborator

brentvatne commented Oct 19, 2015

@kevinzzz007 - short version: we want to build a different version of the docs for every tagged release of React Native, and make it possible to switch between those 😄

@kevinzzz007

This comment has been minimized.

Show comment
Hide comment
@kevinzzz007

kevinzzz007 Oct 20, 2015

@brentvatne that makes sense, since I'm pretty new to doing this, are there recommended approaches? Resources that would be helpful for me to read over for this task?

@brentvatne that makes sense, since I'm pretty new to doing this, are there recommended approaches? Resources that would be helpful for me to read over for this task?

@brentvatne

This comment has been minimized.

Show comment
Hide comment
@brentvatne

brentvatne Oct 25, 2015

Collaborator

@kevinzzz007 - sorry I haven't done this before. You'll want to get familiar with the /website directory within react-native and how deployment to Github pages works.

Collaborator

brentvatne commented Oct 25, 2015

@kevinzzz007 - sorry I haven't done this before. You'll want to get familiar with the /website directory within react-native and how deployment to Github pages works.

@mihirsoni

This comment has been minimized.

Show comment
Hide comment
@mihirsoni

mihirsoni Oct 28, 2015

@brentvatne @mkonicek Could you just provide little more information how you would be expecting to generate.

I tried to modified the publish.sh with taking respective tag version from git describe of the each MR. would it be fine if we update that particular directory ?

@brentvatne @mkonicek Could you just provide little more information how you would be expecting to generate.

I tried to modified the publish.sh with taking respective tag version from git describe of the each MR. would it be fine if we update that particular directory ?

@udnisap

This comment has been minimized.

Show comment
Hide comment
@udnisap

udnisap Nov 19, 2015

Contributor

I will work on this. Quick questions

  1. Do we need a navigation mechanism to navigate from different documentation sources?
  2. Rather than building from the last build shall I build from all the branches with stable suffix? This will allow them to grow/update over time. but it will take few minutes to generate all the sources.
Contributor

udnisap commented Nov 19, 2015

I will work on this. Quick questions

  1. Do we need a navigation mechanism to navigate from different documentation sources?
  2. Rather than building from the last build shall I build from all the branches with stable suffix? This will allow them to grow/update over time. but it will take few minutes to generate all the sources.

udnisap added a commit to udnisap/react-native that referenced this issue Nov 19, 2015

udnisap added a commit to udnisap/react-native that referenced this issue Nov 19, 2015

udnisap added a commit to udnisap/react-native that referenced this issue Nov 25, 2015

@mkonicek

This comment has been minimized.

Show comment
Hide comment
@mkonicek

mkonicek Nov 26, 2015

Contributor

Do we need a navigation mechanism to navigate from different documentation sources?

Feel free to leave this out for now.

Rather than building from the last build shall I build from all the branches with stable suffix? This will allow them to grow/update over time. but it will take few minutes to generate all the sources.

Travis runs on each branch every time there's a commit so it's a good time to regenerate the website exactly for that branch at that moment. It would be very wasteful to regenerate the website for every branch on every commit to master, and it would get slower over time as we add more release branches.

Contributor

mkonicek commented Nov 26, 2015

Do we need a navigation mechanism to navigate from different documentation sources?

Feel free to leave this out for now.

Rather than building from the last build shall I build from all the branches with stable suffix? This will allow them to grow/update over time. but it will take few minutes to generate all the sources.

Travis runs on each branch every time there's a commit so it's a good time to regenerate the website exactly for that branch at that moment. It would be very wasteful to regenerate the website for every branch on every commit to master, and it would get slower over time as we add more release branches.

@dabit3

This comment has been minimized.

Show comment
Hide comment
@dabit3

dabit3 Dec 10, 2015

Contributor

@udnisap @mkonicek Let me know if there's anything I can do here, I have some time opened up over the holidays. thanks.

Contributor

dabit3 commented Dec 10, 2015

@udnisap @mkonicek Let me know if there's anything I can do here, I have some time opened up over the holidays. thanks.

@ide

This comment has been minimized.

Show comment
Hide comment
@ide

ide Dec 10, 2015

Collaborator

@dabit3 we'd love helping hands. Figuring out how to build the version-specific web pages (as outlined in @mkonicek's top post) in a way where we rebuild and redeploy the pages only when committing to a specific version's branch would be superb.

Collaborator

ide commented Dec 10, 2015

@dabit3 we'd love helping hands. Figuring out how to build the version-specific web pages (as outlined in @mkonicek's top post) in a way where we rebuild and redeploy the pages only when committing to a specific version's branch would be superb.

@udnisap

This comment has been minimized.

Show comment
Hide comment
@udnisap

udnisap Dec 13, 2015

Contributor

I have a rough version at https://github.com/facebook/react-native/pull/4234/files which I committed while back.
It does what you asked. Sorry I didnt follow the thread for a while.

Contributor

udnisap commented Dec 13, 2015

I have a rough version at https://github.com/facebook/react-native/pull/4234/files which I committed while back.
It does what you asked. Sorry I didnt follow the thread for a while.

@bestander

This comment has been minimized.

Show comment
Hide comment
@bestander

bestander Feb 10, 2016

Contributor

fixed by #5760
When it lands we have docs for currently stable version at https://facebook.github.io/react-native.
Aside from that all versions of docs will be archived in https://facebook.github.io/react-native/releases path, e.g. https://facebook.github.io/react-native/releases/0.20 and master branch will be at https://facebook.github.io/react-native/releases/next.

In a following up PR we'll do a widget to switch between versions if people need a quick way to find docs for a specific version

Contributor

bestander commented Feb 10, 2016

fixed by #5760
When it lands we have docs for currently stable version at https://facebook.github.io/react-native.
Aside from that all versions of docs will be archived in https://facebook.github.io/react-native/releases path, e.g. https://facebook.github.io/react-native/releases/0.20 and master branch will be at https://facebook.github.io/react-native/releases/next.

In a following up PR we'll do a widget to switch between versions if people need a quick way to find docs for a specific version

@bestander bestander closed this Feb 10, 2016

@facebook facebook locked as resolved and limited conversation to collaborators Jul 21, 2018

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.