[FSSDK-8955] Refac: Replaced all instances of full stack except from changelog file and code files #331

mnoman09 · 2023-03-10T16:54:38Z

Summary

Updated readme file and matched its format with the provided sample readme file.
Removed all occurrences of full stack with Optimizely Feature Experimentation

Test plan

All tests should pass.

Issues

"FSSDK-8955"

…ode files

griffincox-optimizely

I think you need to add Prerequisites and/or Requirements sections (see template.md on story)

Let's talk about breaking apart the "Use the C#SDK" and "Development" sections...

OptimizelySDK.DemoApp/README.md

README.md

griffincox-optimizely

one last change then it LGTM.

README.md

Co-authored-by: Griffin Cox <[email protected]>

russell-loube-optimizely · 2023-03-10T17:34:36Z

README.md


-Optimizely Full Stack is A/B testing and feature flag management for product development teams. Experiment in any application. Make every feature on your roadmap an opportunity to learn. Learn more at https://www.optimizely.com/platform/full-stack/, or see the [documentation](https://docs.developers.optimizely.com/experimentation/v4.0.0-full-stack/docs/welcome).
+Optimizely Feature Experimentation is an A/B testing and feature management for product development teams, letting you experiment at every step. Using Optimizely Feature Experimentation allows for every feature on your roadmap to be an opportunity to discover hidden insights. Learn more at [Optimizely.com](https://www.optimizely.com/products/experiment/feature-experimentation/), or see the [developer documentation](https://docs.developers.optimizely.com/experimentation/v4.0.0-full-stack/docs/welcome).


Suggested change

Optimizely Feature Experimentation is an A/B testing and feature management for product development teams, letting you experiment at every step. Using Optimizely Feature Experimentation allows for every feature on your roadmap to be an opportunity to discover hidden insights. Learn more at [Optimizely.com](https://www.optimizely.com/products/experiment/feature-experimentation/), or see the [developer documentation](https://docs.developers.optimizely.com/experimentation/v4.0.0-full-stack/docs/welcome).

Optimizely Feature Experimentation is an A/B testing and feature management tool for product development teams, letting you experiment at every step. Using Optimizely Feature Experimentation allows for every feature on your roadmap to be an opportunity to discover hidden insights. Learn more at [Optimizely.com](https://www.optimizely.com/products/experiment/feature-experimentation/), or see the [developer documentation](https://docs.developers.optimizely.com/experimentation/v4.0.0-full-stack/docs/welcome).

russell-loube-optimizely · 2023-03-10T17:37:33Z

README.md


-Optimizely Full Stack is A/B testing and feature flag management for product development teams. Experiment in any application. Make every feature on your roadmap an opportunity to learn. Learn more at https://www.optimizely.com/platform/full-stack/, or see the [documentation](https://docs.developers.optimizely.com/experimentation/v4.0.0-full-stack/docs/welcome).
+Optimizely Feature Experimentation is an A/B testing and feature management for product development teams, letting you experiment at every step. Using Optimizely Feature Experimentation allows for every feature on your roadmap to be an opportunity to discover hidden insights. Learn more at [Optimizely.com](https://www.optimizely.com/products/experiment/feature-experimentation/), or see the [developer documentation](https://docs.developers.optimizely.com/experimentation/v4.0.0-full-stack/docs/welcome).


"developer documentation" has two separate links for each word, not sure why (syntax looks correct). Possible to make it one link for the term?

I don't think there is any other way. this is the only syntax which I think that can be used.

russell-loube-optimizely · 2023-03-10T17:39:21Z

README.md


-See the Optimizely Full Stack C# SDK [developer documentation](https://docs.developers.optimizely.com/experimentation/v4.0.0-full-stack/docs/csharp-sdk) to learn how to set up your first Full Stack project and use the SDK.
+## Use the Csharp SDK


Suggested change

## Use the Csharp SDK

## Use the C# SDK

README.md

russell-loube-optimizely · 2023-03-10T21:25:27Z

README.md

-### Installing the SDK
+## Get Started
+
+Refer to the [Csharp SDK's developer documentation](https://docs.developers.optimizely.com/experimentation/v4.0.0-full-stack/docs/csharp-sdk) for detailed instructions on getting started with using the SDK.


Nit:

Suggested change

Refer to the [Csharp SDK's developer documentation](https://docs.developers.optimizely.com/experimentation/v4.0.0-full-stack/docs/csharp-sdk) for detailed instructions on getting started with using the SDK.

Refer to the [C# SDK's developer documentation](https://docs.developers.optimizely.com/experimentation/v4.0.0-full-stack/docs/csharp-sdk) for detailed instructions on getting started with using the SDK.

russell-loube-optimizely · 2023-03-10T21:30:00Z

README.md

-The sample project contains unit tests as well which can be run from the built-in Visual Studio Test Runner.
-
-### Contributing
+## Contributing


Suggested change

## Contributing

## SDK Development

### Contributing

russell-loube-optimizely · 2023-03-10T21:31:20Z

README.md

-The sample project contains unit tests as well which can be run from the built-in Visual Studio Test Runner.
-
-### Contributing
+## Contributing

 Please see [CONTRIBUTING](CONTRIBUTING.md).



Change line 223 to ### Third Party Licenses

russell-loube-optimizely · 2023-03-10T21:33:11Z

docs/readme-sync/sdk-reference-guides/csharp-sdk/040 - optimizelyconfig-csharp.md

@@ -10,7 +10,7 @@ updatedAt: "2020-01-28T21:53:11.290Z"
  "title": "Overview"


Change looks good, but md file as a whole doesn't seem to be rendering properly. Could you please take a look?

russell-loube-optimizely · 2023-03-10T21:35:11Z

docs/readme-sync/sdk-reference-guides/csharp-sdk/070 - event-batching-csharp.md

@@ -5,7 +5,7 @@ hidden: false
 createdAt: "2019-09-12T13:44:04.059Z"


Also doesn't seem to be rendering properly, could you please double check?

russell-loube-optimizely · 2023-03-10T21:36:22Z

.github/workflows/csharp.yml

@@ -38,7 +38,7 @@ jobs:
      TRAVIS_COM_TOKEN: ${{ secrets.TRAVIS_COM_TOKEN }}

  fullstack_production_suite:
-    name: Run Full Stack Compatibility Suite
+    name: Run Optimizely Feature Experimentation Compatibility Suite


Totally fine with the change so long as you don't think it would be confusing since we still call the test suite by "FSC".

I am not sure are we are going to rename FSC as well?

Funny. What can be a good name to replace it internally. FXC? @russell-loube-optimizely

russell-loube-optimizely · 2023-03-10T21:37:12Z

docs/readme-sync/sdk-reference-guides/csharp-sdk/190 - track-csharp.md

@@ -91,7 +91,7 @@ The table lists other other Optimizely functionality that may be triggered by us
    "h-0": "Functionality",


Also not rendering properly?

jaeopt

LGTM

jaeopt · 2023-03-10T22:36:00Z

.github/workflows/csharp.yml

@@ -38,7 +38,7 @@ jobs:
      TRAVIS_COM_TOKEN: ${{ secrets.TRAVIS_COM_TOKEN }}

  fullstack_production_suite:
-    name: Run Full Stack Compatibility Suite
+    name: Run Optimizely Feature Experimentation Compatibility Suite


Funny. What can be a good name to replace it internally. FXC? @russell-loube-optimizely

russell-loube-optimizely

LGTM

mikechu-optimizely · 2023-03-10T22:54:16Z

I didn't even think about FSC and FXC naming now @jaeopt Good call out

mikechu-optimizely · 2023-03-10T23:03:02Z

@mnoman09 The linter is not happy with the markdown. Should we disable validation or go ahead and clean based on the rules?

mikechu-optimizely · 2023-03-14T14:01:52Z

I disabled super-linter's markdown linting. Waiting for FSC to finish successfully.

mikechu-optimizely · 2023-03-14T14:06:40Z

@mnoman09 Should I go ahead and squash+merge?

mikechu-optimizely · 2023-03-14T15:22:50Z

.github/workflows/csharp.yml

@@ -38,7 +37,7 @@ jobs:
      TRAVIS_COM_TOKEN: ${{ secrets.TRAVIS_COM_TOKEN }}

  fullstack_production_suite:
-    name: Run Full Stack Compatibility Suite
+    name: Run Optimizely Feature Experimentation Compatibility Suite


@mnoman09 I wonder if @russell-loube-optimizely is on point here. The ping is not completing b/c we've renamed the job. Maybe revert this particular instance.

No this does not have to do with the issue because build uses fullstack_production_suite as ID and it is running fine.

Cool. I'll merge then.

…changelog file and code files (#331) * Replaced all instances of full stack except from changelog file and code files Co-authored-by: Griffin Cox <[email protected]> * [FSSDK-8955] Do not lint markdown for now * [FSSDK-8955] Remove VALIDATE_MARKDOWN --------- Co-authored-by: mnoman09 <[email protected]> Co-authored-by: Griffin Cox <[email protected]> Co-authored-by: Mike Chu <[email protected]> (cherry picked from commit 5f16357)

…changelog file and code files (#331) * Replaced all instances of full stack except from changelog file and code files Co-authored-by: Griffin Cox <[email protected]> * [FSSDK-8955] Do not lint markdown for now * [FSSDK-8955] Remove VALIDATE_MARKDOWN --------- Co-authored-by: mnoman09 <[email protected]> Co-authored-by: Griffin Cox <[email protected]> Co-authored-by: Mike Chu <[email protected]> (cherry picked from commit 5f16357) (cherry picked from commit 887166e)

* chore : updated prefix of ticket-check action (#314) (cherry picked from commit 678c6fd) * chore: Fix and Reconfigure GitHub Actions (#319) * Fix <return> method doc for IsFeatureEnabled (#329) * [FSSDK-8938] chore: Updated newtonsoft.Json version and NjsonSchema version (#330) * [FSSDK-8955] Refac: Replaced all instances of full stack except from changelog file and code files (#331) * Replaced all instances of full stack except from changelog file and code files Co-authored-by: Griffin Cox <[email protected]> * [FSSDK-8955] Do not lint markdown for now * [FSSDK-8955] Remove VALIDATE_MARKDOWN --------- Co-authored-by: mnoman09 <[email protected]> Co-authored-by: Griffin Cox <[email protected]> Co-authored-by: Mike Chu <[email protected]> (cherry picked from commit 5f16357) (cherry picked from commit 887166e) * [FSSDK-8955] Refac: Replaced all instances of full stack from code comments and in nuspec except owner. (#332) (cherry picked from commit 2a5b19c) * [FSSDK-8955] chore: prepare for release 3.11.2 (#333) * [FSSDK-8955] chore: prepare for release 3.11.2 * Nit fixed --------- Co-authored-by: mnoman09 <[email protected]> (cherry picked from commit e620c08) * updated release date to 16th March --------- Co-authored-by: Muhammad Shaharyar <[email protected]> Co-authored-by: Mike Chu <[email protected]> Co-authored-by: mnoman09 <[email protected]>

Replaced all instances of full stack except from changelog file and c…

e29a8b8

…ode files

mnoman09 requested a review from a team as a code owner March 10, 2023 16:54

optimizely-codereview-bot assigned mnoman09 Mar 10, 2023

mnoman09 removed their assignment Mar 10, 2023

griffincox-optimizely reviewed Mar 10, 2023

View reviewed changes

fixes

27094a0

griffincox-optimizely reviewed Mar 10, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

Update README.md

15b20f1

Co-authored-by: Griffin Cox <[email protected]>

russell-loube-optimizely reviewed Mar 10, 2023

View reviewed changes

mikechu-optimizely mentioned this pull request Mar 10, 2023

[FSSDK-8955] Refac: Replaced all instances of full stack from code comments and in nuspec except owner. #332

Merged

fixed

b5e8140

russell-loube-optimizely reviewed Mar 10, 2023

View reviewed changes

resolved

46c1633

jaeopt approved these changes Mar 10, 2023

View reviewed changes

russell-loube-optimizely reviewed Mar 10, 2023

View reviewed changes

mikechu-optimizely added 2 commits March 14, 2023 09:13

[FSSDK-8955] Do not lint markdown for now

5449c90

[FSSDK-8955] Remove VALIDATE_MARKDOWN

5ed3318

mikechu-optimizely reviewed Mar 14, 2023

View reviewed changes

mnoman09 closed this Mar 14, 2023

mnoman09 reopened this Mar 14, 2023

optimizely-codereview-bot assigned mnoman09 Mar 14, 2023

mnoman09 merged commit 5f16357 into master Mar 14, 2023

mnoman09 deleted the mnoman/mdFilesUpdate branch March 14, 2023 19:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FSSDK-8955] Refac: Replaced all instances of full stack except from changelog file and code files #331

[FSSDK-8955] Refac: Replaced all instances of full stack except from changelog file and code files #331

mnoman09 commented Mar 10, 2023

griffincox-optimizely left a comment

griffincox-optimizely left a comment

russell-loube-optimizely Mar 10, 2023

russell-loube-optimizely Mar 10, 2023

mnoman09 Mar 10, 2023

russell-loube-optimizely Mar 10, 2023

russell-loube-optimizely Mar 10, 2023

russell-loube-optimizely Mar 10, 2023

russell-loube-optimizely Mar 10, 2023

russell-loube-optimizely Mar 10, 2023

russell-loube-optimizely Mar 10, 2023

russell-loube-optimizely Mar 10, 2023

mnoman09 Mar 10, 2023

jaeopt Mar 10, 2023

russell-loube-optimizely Mar 10, 2023

jaeopt left a comment

jaeopt Mar 10, 2023

russell-loube-optimizely left a comment

mikechu-optimizely commented Mar 10, 2023

mikechu-optimizely commented Mar 10, 2023

mikechu-optimizely commented Mar 14, 2023

mikechu-optimizely commented Mar 14, 2023

mikechu-optimizely Mar 14, 2023

mnoman09 Mar 14, 2023

mikechu-optimizely Mar 14, 2023


		Optimizely Full Stack is A/B testing and feature flag management for product development teams. Experiment in any application. Make every feature on your roadmap an opportunity to learn. Learn more at https://www.optimizely.com/platform/full-stack/, or see the [documentation](https://docs.developers.optimizely.com/experimentation/v4.0.0-full-stack/docs/welcome).
		Optimizely Feature Experimentation is an A/B testing and feature management for product development teams, letting you experiment at every step. Using Optimizely Feature Experimentation allows for every feature on your roadmap to be an opportunity to discover hidden insights. Learn more at [Optimizely.com](https://www.optimizely.com/products/experiment/feature-experimentation/), or see the [developer documentation](https://docs.developers.optimizely.com/experimentation/v4.0.0-full-stack/docs/welcome).


		See the Optimizely Full Stack C# SDK [developer documentation](https://docs.developers.optimizely.com/experimentation/v4.0.0-full-stack/docs/csharp-sdk) to learn how to set up your first Full Stack project and use the SDK.
		## Use the Csharp SDK

	Refer to the [Csharp SDK's developer documentation](https://docs.developers.optimizely.com/experimentation/v4.0.0-full-stack/docs/csharp-sdk) for detailed instructions on getting started with using the SDK.
	Refer to the [C# SDK's developer documentation](https://docs.developers.optimizely.com/experimentation/v4.0.0-full-stack/docs/csharp-sdk) for detailed instructions on getting started with using the SDK.

		@@ -10,7 +10,7 @@ updatedAt: "2020-01-28T21:53:11.290Z"
		"title": "Overview"

		@@ -5,7 +5,7 @@ hidden: false
		createdAt: "2019-09-12T13:44:04.059Z"

		@@ -91,7 +91,7 @@ The table lists other other Optimizely functionality that may be triggered by us
		"h-0": "Functionality",

[FSSDK-8955] Refac: Replaced all instances of full stack except from changelog file and code files #331

[FSSDK-8955] Refac: Replaced all instances of full stack except from changelog file and code files #331

Conversation

mnoman09 commented Mar 10, 2023

Summary

Test plan

Issues

griffincox-optimizely left a comment

Choose a reason for hiding this comment

griffincox-optimizely left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jaeopt left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

russell-loube-optimizely left a comment

Choose a reason for hiding this comment

mikechu-optimizely commented Mar 10, 2023

mikechu-optimizely commented Mar 10, 2023

mikechu-optimizely commented Mar 14, 2023

mikechu-optimizely commented Mar 14, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment