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

docs(Issue179): Modify some parts of the documentation to mention the new 1.1.0-alpha #202

Merged
merged 3 commits into from
Oct 15, 2021
Merged

docs(Issue179): Modify some parts of the documentation to mention the new 1.1.0-alpha #202

merged 3 commits into from
Oct 15, 2021

Conversation

LoganTann
Copy link

@LoganTann LoganTann commented Oct 6, 2021 •
edited
Loading

Proposed changes

  1. Change the 1.0.0 to 1.1.0 in the first option of the dropdown. Add a new dropdown link between 1.1.0 and 0.100.2 with the content 1.0.0 that redirects to the official docs (materializecss.com). Moved from http to https for the archive doc link.
    2. Remove the upgrade guide and its button in the index page docs

Screenshots (if appropriate) or codepen:

none (see the orignal issue for what parts of the docs are changed).

Types of changes

  • documentation only

Checklist:

  • I have read the CONTRIBUTING document.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

closes #179

@LoganTann
docs(navbar): change version from 1.0.0 to 1.1.0 in the docs version …
8a8dcd1 
…dropdown

changed all occurences of 1.1.0 to 1.0.0, then added a 1.0.0 link option than points to the official
docs, and edited the 0.100.0 docs links to use https instead of http

fix #179
@LoganTann
docs(index_content): remove the 0.100.2 upgrade guide button as well …
5d93e4d 
…as the v1-upgrade-guide.md file

Since it's no longer needed. 0.100.2 is very very old.
@LoganTann LoganTann mentioned this pull request Oct 6, 2021
Closed
5 tasks
@DanielRuf
Copy link

I'm not sure regarding the upgrade guide since there are still many projects which use the original version and some 0.x release.

@Smankusors
Copy link
Member

btw is this still WIP? You should convert this PR as draft

@Smankusors Smankusors linked an issue Oct 6, 2021 that may be closed by this pull request
Modify some parts of the documentation to mention the new 1.1.0-alpha #179
Closed
@LoganTann
Copy link
Author

LoganTann commented Oct 6, 2021 •
edited
Loading

btw is this still WIP? You should convert this PR as draft

Basically it's ready to be merged, but we have to discuss :

  • As mentioned in the original issue, should I add a text "since 1.1.0" to options introduced in that pre-release ? In that PR or in another one ?
  • Is it needed to deleted the upgrade guide ? (in my opinion, yes but according to Daniel, not really)

(edit : seems like only admins of the repo can convert an existing PR into a draft PR)

@DanielRuf DanielRuf marked this pull request as draft October 7, 2021 06:52
@LoganTann
Copy link
Author

I think I will just revert the deletion of the upgrade guide, and open a new PR for the text "since 1.x" in order for this issue to get merged
I'll work on it tonight

@LoganTann
refactor(v1-upgrade-guide): restore the deletion of the file v1-upgra…
6a3e213 
…de-guide

Since there are still many projects which use the original version and some 0.x release, it has been
decided to not delete the v1-upgrade-guide.md file
@LoganTann LoganTann marked this pull request as ready for review October 11, 2021 20:42
@LoganTann LoganTann changed the title docs(Issue179): [WIP] Modify some parts of the documentation to mention the new 1.1.0-alpha docs(Issue179): Modify some parts of the documentation to mention the new 1.1.0-alpha Oct 11, 2021
@LoganTann
Copy link
Author

Hello, is there anyone available to review my PR ? @materializecss/members

@DanielRuf DanielRuf requested a review from a team October 15, 2021 11:16
@DanielRuf
Copy link

@LoganTann can you also see this option to invite the group as reviewer?

image

I've assigned the group for the review now.
So people, please feel free to review, approve and merge =)

Smankusors
Smankusors approved these changes Oct 15, 2021
View reviewed changes
Copy link
Member

@Smankusors Smankusors left a comment

Choose a reason for hiding this comment

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

LGTM

@DanielRuf DanielRuf merged commit aa686d1 into materializecss:main Oct 15, 2021
@LoganTann
Copy link
Author

@LoganTann can you also see this option to invite the group as reviewer?

Oh I never noticed it, thanks for the reply !

@LoganTann LoganTann deleted the issue179-docsVersion branch October 16, 2021 10:01
@Smankusors Smankusors added the documentation Improvements or additions to documentation label Apr 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Smankusors Smankusors Smankusors approved these changes

@ChildishGiant ChildishGiant Awaiting requested review from ChildishGiant

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Modify some parts of the documentation to mention the new 1.1.0-alpha
3 participants
@LoganTann @DanielRuf @Smankusors