Skip to content
This repository has been archived by the owner on Jul 11, 2023. It is now read-only.

[HOLD] chore(release): update osm version links and references. #3467

Closed
wants to merge 2 commits into from
Closed

[HOLD] chore(release): update osm version links and references. #3467

wants to merge 2 commits into from

Conversation

allenlsy
Copy link
Contributor

@allenlsy allenlsy commented May 27, 2021 •
edited
Loading

[HOLD] This PR should be reviewed after the release of v0.9.0

Signed-off-by: Allen Leigh [email protected]

Description:

Update links and OSM version references to v0.9 where possible.

These includes but not limited to:

  • Docker image version
  • Links in documentation

Affected area:

Functional Area
New Functionality [ ]
Documentation [x]
Install [ ]
CLI Tool [ ]
Certificate Management [ ]
Control Plane [ ]
Ingress [ ]
Egress [ ]
Networking [ ]
Observability [ ]
SMI Policy [ ]
Sidecar Injection [ ]
Security [ ]
Upgrade [ ]
Tests [ ]
CI System [ ]
Demo [ ]
Performance [ ]
Other [x]

Please answer the following questions with yes/no.

  1. Does this change contain code from or inspired by another project?
    • Did you notify the maintainers and provide attribution?

No

  1. Is this a breaking change?

No

@allenlsy allenlsy requested a review from a team as a code owner May 27, 2021 16:50
@allenlsy allenlsy requested review from nojnhuh and snehachhabria May 27, 2021 16:50
snehachhabria
snehachhabria suggested changes May 27, 2021
View reviewed changes
Copy link
Contributor

@snehachhabria snehachhabria left a comment •
edited
Loading

Choose a reason for hiding this comment

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

This PR conflicts with the idea's in PR : #3461 . Lets come up with one approach and follow that

nojnhuh
nojnhuh suggested changes May 27, 2021
View reviewed changes
DESIGN.md Outdated Show resolved Hide resolved
pkg/identity/types.go Outdated Show resolved Hide resolved
docs/release_guide.md Outdated Show resolved Hide resolved
docs/demos/first_steps.md
@@ -11,17 +11,17 @@ release: 0.8.0
# Open Service Mesh Demo: First Steps


> Note: This demo is specific to OSM v0.8.0
> Note: This demo is specific to OSM v0.9.0
Copy link
Contributor

Choose a reason for hiding this comment

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

Overall I think demo instructions that live in this repo should always refer to the current commit. That would involve removing instructions for downloading the latest release and only including instructions to build from source. It seems like the docs site is better suited for instructions pertaining to a particular version of OSM (which may or may not be current).

Those kinds of changes are out of scope here though and probably need more discussion.

fyi @bridgetkromhout

docs/demos/first_steps.md Outdated Show resolved Hide resolved
pkg/configurator/methods_test.go Outdated Show resolved Hide resolved
@allenlsy allenlsy force-pushed the update-ref-release-0.9 branch 3 times, most recently from abbc574 to 6d415c7 Compare May 27, 2021 20:21
nojnhuh
nojnhuh previously approved these changes May 27, 2021
View reviewed changes
Copy link
Contributor

@nojnhuh nojnhuh left a comment

Choose a reason for hiding this comment

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

Left one more comment, but lgtm.

Let's also cherry-pick this to the main branch.

docs/dev_guide/_index.md Outdated
Comment on lines 250 to 239
- [creates a fake MeshConfig](https://github.com/openservicemesh/osm/blob/release-v0.9/pkg/configurator/client_test.go#L28-48)
- [tests whether](https://github.com/openservicemesh/osm/blob/release-v0.9/pkg/configurator/client_test.go#L68) a event message is broadcasted to data plane proxy.
Copy link
Contributor

Choose a reason for hiding this comment

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

These links could be relative.

@allenlsy
Copy link
Contributor Author

@nojnhuh are we sure to merge this to main branch? Since some of the links are pointing to v0.9, which is not released yet. I would prefer merging it to release-v0.9 branch, or wait for v0.9 to be released then merge to main.

@allenlsy allenlsy force-pushed the update-ref-release-0.9 branch from 6d415c7 to b5b1231 Compare May 27, 2021 21:48
@nojnhuh
Copy link
Contributor

nojnhuh commented May 27, 2021

@nojnhuh are we sure to merge this to main branch? Since some of the links are pointing to v0.9, which is not released yet. I would prefer merging it to release-v0.9 branch, or wait for v0.9 to be released then merge to main.

We should at least mirror the changes making the links relative on the main branch. I don't feel strongly that it needs to be done before we cut v0.9.0, but we should do it at some point.

The references to v0.9.0-rc.1 in the demo we can probably hold off on until we cut v0.9.0 and update those to v0.9.0 then.

@allenlsy
Copy link
Contributor Author

@nojnhuh ok agree. In this case, shall we just use your PR and merge to main?

So this PR will rebase to main after 0.9 is released

@nojnhuh
Copy link
Contributor

nojnhuh commented May 27, 2021

@nojnhuh ok agree. In this case, shall we just use your PR and merge to main?

So this PR will rebase to main after 0.9 is released

That makes sense to me. There might be a couple of changes you made here that I missed, but I'll check and make sure those are included in my PR to main before I merge.

@allenlsy allenlsy changed the title chore(release): update osm version links and references. [HOLD] chore(release): update osm version links and references. May 28, 2021
@allenlsy allenlsy force-pushed the update-ref-release-0.9 branch from b5b1231 to 1b5968b Compare June 15, 2021 16:31
@allenlsy
ref(docs): use relative links to repo files
450051d 
When all of the docs in this repo were published to
https://docs.openservicemesh.io, we decided to use absolute links to
other files in this repo so they would work from the website. Now that
these docs are no longer rendered on the website, these links only need
to work on GitHub, which supports relative links. Making the links
relative unambiguously refers to the file in the same commit and
eliminates any need to manually keep them up to date when a new release
branch is created.

This commit also update necessary version numbers in documents and code.

Signed-off-by: Jon Huhn <[email protected]>
Signed-off-by: Allen Leigh <[email protected]>
@allenlsy allenlsy force-pushed the update-ref-release-0.9 branch from 1b5968b to 450051d Compare June 15, 2021 16:51
@allenlsy allenlsy changed the base branch from release-v0.9 to main June 15, 2021 16:52
@allenlsy
Copy link
Contributor Author

This PR is superseded by #3592.

@allenlsy allenlsy closed this Jun 15, 2021
@allenlsy allenlsy deleted the update-ref-release-0.9 branch July 12, 2021 18:51
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@snehachhabria snehachhabria snehachhabria requested changes

@nojnhuh nojnhuh nojnhuh left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@allenlsy @nojnhuh @snehachhabria