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

Add support for multiple releases in documentation #19

Merged
merged 5 commits into from
Oct 16, 2020
Merged

Add support for multiple releases in documentation #19

merged 5 commits into from
Oct 16, 2020

Conversation

tux-rampage
Copy link
Member

Q A
Documentation yes
Bugfix yes
BC Break no
New Feature yes
RFC yes
QA yes

Description

This PR aims to add support for multiple versions/releases to the documentation pages as requested in #8

@tux-rampage
Add version tree to mkdocs config
30861fa 
Signed-off-by: tux-rampage <tuxrampage@gmail.com>
@tux-rampage
Restore quick start page from 2.x release
6b12801 
Signed-off-by: tux-rampage <tuxrampage@gmail.com>
@tux-rampage tux-rampage added this to the 3.2.0 milestone Oct 6, 2020
@tux-rampage tux-rampage added this to In progress in Documentation: improvements via automation Oct 6, 2020
@tux-rampage tux-rampage changed the title Feature/documentation versions Add support for multiple releases in documentation Oct 6, 2020
@tux-rampage tux-rampage linked an issue Oct 6, 2020 that may be closed by this pull request
Wrong handling of versions in documentation #8
Closed
@tux-rampage
Copy link
Member Author

@froschdesign Should we move the current docs to a v3 subdirectory? I guess this will require to modify all page references to be prefixed with v3/ then, right?

tux-rampage
tux-rampage commented Oct 6, 2020
View reviewed changes
mkdocs.yml Show resolved Hide resolved
froschdesign
froschdesign requested changes Oct 8, 2020
View reviewed changes
Copy link
Member

@froschdesign froschdesign left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only some small changes and improvements are needed.

mkdocs.yml Outdated Show resolved Hide resolved
mkdocs.yml Outdated Show resolved Hide resolved
docs/book/v2/quick-start.md Show resolved Hide resolved
docs/book/v2/quick-start.md Show resolved Hide resolved
docs/book/v2/quick-start.md Show resolved Hide resolved
Documentation: improvements automation moved this from In progress to Review in progress Oct 8, 2020
@tux-rampage
Add suggested changes
2f259a3 
Signed-off-by: tux-rampage <tuxrampage@gmail.com>
@tux-rampage
Correct headline position
a573fbd 
Signed-off-by: tux-rampage <tuxrampage@gmail.com>
@tux-rampage
Change code segment for visualizing the default di instance
b0e6d5e 
Signed-off-by: tux-rampage <tuxrampage@gmail.com>
Documentation: improvements automation moved this from Review in progress to Reviewer approved Oct 15, 2020
@tux-rampage tux-rampage merged commit fe6fc36 into laminas:3.2.x Oct 16, 2020
Documentation: improvements automation moved this from Reviewer approved to Done Oct 16, 2020
@tux-rampage tux-rampage mentioned this pull request Oct 22, 2020
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@froschdesign froschdesign froschdesign approved these changes

Assignees
No one assigned
Labels
Documentation
Projects
Documentation: improvements
  
Done
Milestone
3.2.0
Development

Successfully merging this pull request may close these issues.

Wrong handling of versions in documentation
2 participants
@tux-rampage @froschdesign