Skip to content
This repository has been archived by the owner on Sep 5, 2024. It is now read-only.

Provide versioning of Online Docs #918

Closed
ThomasBurleson opened this issue Dec 11, 2014 · 6 comments
Closed

Provide versioning of Online Docs #918

ThomasBurleson opened this issue Dec 11, 2014 · 6 comments
Assignees
@matthewrfindley
Labels
for: internal contributor The team will address this issue and community PRs are not requested. resolution: fixed type: build type: docs type: feature
Milestone
1.0-rc1

Comments

@ThomasBurleson
Copy link
Contributor

Similar to doc versioning in AngularJS 1.x:

doc_versioning

Will need to use the Select menu also planned for 0.8 Milestone release.
@ThomasBurleson ThomasBurleson added this to the 0.8.0-rc1 milestone Dec 11, 2014
@marcysutton marcysutton mentioned this issue Dec 18, 2014
Closed
@ThomasBurleson ThomasBurleson mentioned this issue Dec 18, 2014
Closed
5 tasks
@marcysutton marcysutton mentioned this issue Dec 18, 2014
Closed
@PaulMougel PaulMougel mentioned this issue Dec 23, 2014
Closed
@gkalpak gkalpak mentioned this issue Dec 23, 2014
Closed
@epelc
Copy link
Contributor

epelc commented Jan 4, 2015

@ThomasBurleson If we decide to implement #1103 then I think hyperboot would go really well with it.

Hyperboot allows you to save several versions of a webapp for offline viewing with the help of appcache. So if you view a version of the docs while you are online it will be available when you are offline. You can also add js to download all versions and to set defaults for which version to load.

@marcysutton marcysutton mentioned this issue Jan 6, 2015
Closed
This was referenced Jan 22, 2015
Closed
Closed
@marcysutton marcysutton modified the milestones: 0.9.0, 0.8.0-rc1 Feb 3, 2015
radamant pushed a commit to radamant/material that referenced this issue Mar 13, 2015
docs(versions): provide version menu for navigating to versioned docs
503f5f8 
Refs angular#918 provides version menu (with customizable min-version cutoff)
that navigates to docs based on a simple string format.

This approach was based on that provided in the base angular.js repo,
and some of the code was ported from that repo.

Port version configuration fetching from main angular.js project

Version Configuration is gathered on doc generation

Remove debug statements

Show version list in docs menu

Only show 0.8.3 and greater in version list

Only generate urls for docs for 0.8.0 and greater

Filter based on docUrl instead of version number

Fix spacing per guidelines

Add accessibility to version dropdown

Add placeholder text instead of aria-label

Add more spaces before braces

Support CDNVersion

Make docs url and minimum version configurable

Navigate to a new URL when the version select changes
radamant pushed a commit to radamant/material that referenced this issue Mar 13, 2015
docs(versions): provide version menu for navigating to versioned docs
8d7ef39 
Refs angular#918 provides version menu (with customizable min-version cutoff)
that navigates to docs based on a simple string format.

This approach was based on that provided in the base angular.js repo,
and some of the code was ported from that repo.
radamant pushed a commit to radamant/material that referenced this issue Mar 13, 2015
docs(versions): provide version menu for navigating to versioned docs
450700e 
Refs angular#918 provides version menu (with customizable min-version cutoff)
that navigates to docs based on a simple string format.

This approach was based on that provided in the base angular.js repo,
and some of the code was ported from that repo.
@radamant radamant mentioned this issue Mar 13, 2015
Closed
@marcysutton
Copy link
Contributor

Discussed:

  1. How far back to include picker: old versions of docs will have different links, structure, etc.
  2. UI for picker: select? dropdown? archive page?
  3. Where to host snapshots? Angularjs snapshots hosted on code.angularjs.org
  4. Picker and docs site should include master but default to latest tag

@epelc
Copy link
Contributor

epelc commented Mar 24, 2015

@marcus tutor did you take a look at hyperboot by any chance? It seems like a really good fit for this + you get offline support.

@marcysutton
Copy link
Contributor

@epelc I'll assume "Marcus tutor" was supposed to be me? 😜

We haven't yet, but that's a great idea. I'll have a look.

@epelc
Copy link
Contributor

epelc commented Mar 24, 2015

@marcysutton utton yes I think auto correct got it. Andoird is so aggressive with its spell checking.

@marcysutton marcysutton modified the milestones: 0.10.0, 0.9.0 Apr 1, 2015
@ThomasBurleson
Copy link
Contributor Author

Feature Summary:

  • Lock the documentation with its associated release.
  • Provide a version picker to choose the associated documentation with download zip link.
  • Continue provide development documentation linked to current #master development branch.

@ThomasBurleson ThomasBurleson added the for: internal contributor The team will address this issue and community PRs are not requested. label Apr 24, 2015
@matthewrfindley matthewrfindley mentioned this issue May 19, 2015
Closed
@ThomasBurleson ThomasBurleson modified the milestones: 0.10.0, 0.11.0 Jun 16, 2015
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@matthewrfindley matthewrfindley

Labels
for: internal contributor The team will address this issue and community PRs are not requested. resolution: fixed type: build type: docs type: feature
Projects
None yet
Milestone
1.0-rc1
Development

Successfully merging a pull request may close this issue.

feat(docs): version selection angular/material
4 participants
@ThomasBurleson @matthewrfindley @marcysutton @epelc