|
| 1 | +# Remove Main Feedback Flow Release Plan (Simplified) |
| 2 | + |
| 3 | +## Overview |
| 4 | +Create a `no-feedback` branch that removes the main feedback flow with minimal code changes while keeping thumbs up/down feedback after Q&A responses. Consumers keep the same API - the "Provide feedback to ACCESS" option simply doesn't appear. Use existing publishing workflow with beta tagging. |
| 5 | + |
| 6 | +## Phase 1: Create Branch Without Main Feedback Flow |
| 7 | + |
| 8 | +### Step 1.1: Create Branch from Current Main |
| 9 | +```bash |
| 10 | +git checkout main |
| 11 | +git pull upstream main |
| 12 | +git checkout -b no-feedback main |
| 13 | +``` |
| 14 | + |
| 15 | +### Step 1.2: Minimal Code Changes to Remove Main Feedback Flow |
| 16 | + |
| 17 | +**Simple approach: Comment out main feedback flow only (keep thumbs up/down)** |
| 18 | + |
| 19 | +1. **Main Menu Flow** (`src/utils/flows/main-menu-flow.js`): |
| 20 | + ```javascript |
| 21 | + options: [ |
| 22 | + "Ask a question about ACCESS", |
| 23 | + "Open a Help Ticket", |
| 24 | + // "Provide feedback to ACCESS", // COMMENTED OUT |
| 25 | + "Report a security issue" |
| 26 | + ] |
| 27 | + ``` |
| 28 | + |
| 29 | +2. **Bot Flow Creation** (`src/utils/create-bot-flow.js`): |
| 30 | + ```javascript |
| 31 | + return { |
| 32 | + ...mainMenuFlow, |
| 33 | + ...qaFlow, |
| 34 | + // ...(feedbackFlow || {}), // COMMENTED OUT |
| 35 | + ...supportFlow, |
| 36 | + ...securityFlow |
| 37 | + }; |
| 38 | + ``` |
| 39 | + |
| 40 | +**Q&A Flow thumbs up/down stays unchanged** - Users can still provide quick feedback after each answer. |
| 41 | + |
| 42 | +**Result**: Same API, main feedback flow doesn't appear, but thumbs up/down feedback remains active. |
| 43 | + |
| 44 | +## Phase 2: Beta Release |
| 45 | + |
| 46 | +Follow **Section 1: Feature Development** from `publishing.md` but use beta versioning: |
| 47 | + |
| 48 | +```bash |
| 49 | +# Update package.json to "version": "2.3.0-beta.1" |
| 50 | +# Follow publishing.md: npm install, build:lib, build, commit |
| 51 | +git commit -am "Release v2.3.0-beta.1: Remove main feedback flow (keep thumbs up/down)" |
| 52 | + |
| 53 | +# Tag and publish |
| 54 | +git tag -a v2.3.0-beta.1 -m "Remove main feedback flow (keep thumbs up/down)" |
| 55 | +git push upstream no-feedback --tags |
| 56 | + |
| 57 | +# Follow publishing.md Section 2: Publish with beta tag |
| 58 | +npm publish --tag beta --access public |
| 59 | +``` |
| 60 | + |
| 61 | +## Phase 4: Consumer Usage |
| 62 | + |
| 63 | +**No code changes needed for consumers!** |
| 64 | + |
| 65 | +### NPM Installation |
| 66 | +```bash |
| 67 | +# They just install the beta version |
| 68 | +npm install @snf/access-qa-bot@beta |
| 69 | +``` |
| 70 | + |
| 71 | +### Package.json Version |
| 72 | +After installation, the version will appear in their `package.json` as: |
| 73 | +```json |
| 74 | +{ |
| 75 | + "dependencies": { |
| 76 | + "@snf/access-qa-bot": "^2.3.0-beta.1" |
| 77 | + } |
| 78 | +} |
| 79 | +``` |
| 80 | + |
| 81 | +Or if they want to pin to the exact beta version: |
| 82 | +```json |
| 83 | +{ |
| 84 | + "dependencies": { |
| 85 | + "@snf/access-qa-bot": "2.3.0-beta.1" |
| 86 | + } |
| 87 | +} |
| 88 | +``` |
| 89 | + |
| 90 | +### CDN Links |
| 91 | +**CDN Links work automatically:** |
| 92 | +```html |
| 93 | +< script src= "https://cdn.jsdelivr.net/gh/necyberteam/[email protected]/build/static/js/main.js"></ script> |
| 94 | +``` |
| 95 | + |
| 96 | +## Phase 5: Future Management |
| 97 | + |
| 98 | +- **Promote to stable**: Follow `publishing.md` Section 6 if needed |
| 99 | +- **Maintain branch**: Merge from main as needed, preserving commented-out feedback code |
| 100 | +- **Switch back**: Consumers just change to `@latest` when ready |
| 101 | + |
| 102 | +## Summary |
| 103 | + |
| 104 | +- **Minimal changes**: Just comment out main feedback flow (keep thumbs up/down) |
| 105 | +- **No API changes**: Consumers use exact same code |
| 106 | +- **Existing workflow**: Follow `publishing.md` with beta tagging |
| 107 | +- **Clean versioning**: 2.2.0 → 2.3.0-beta.1 |
| 108 | + |
| 109 | +This gives consumers exactly what they want: latest features without the main feedback flow, but retaining quick thumbs up/down feedback after Q&A responses. No code changes required. |
0 commit comments