Skip to content

Commit 07b26d1

Browse files
authored
update doc relative paths remove agentops (#51)
1 parent ab1083b commit 07b26d1

73 files changed

Lines changed: 252 additions & 246 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/docs-pr-preview.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ on:
66
paths:
77
- 'docs/**'
88

9+
permissions:
10+
pull-requests: write
11+
912
defaults:
1013
run:
1114
working-directory: ./docs
@@ -36,6 +39,8 @@ jobs:
3639
run: npm test
3740

3841
- name: Comment PR
42+
if: github.event.pull_request.head.repo.full_name == github.repository
43+
continue-on-error: true
3944
uses: actions/github-script@v7
4045
with:
4146
script: |

docs/CLAUDE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@ npm run test:coverage # Run tests with v8 coverage
2626

2727
The project produces two separate Astro builds merged into one output:
2828

29-
1. **Main marketing site** (`src/`) — Astro + React + Tailwind. Single-page landing at `/opensearch-agentops-website/`. Configured in root `astro.config.mjs`.
30-
2. **Documentation site** (`starlight-docs/`) — Astro Starlight. Served at `/opensearch-agentops-website/docs/`. Has its own `package.json` and `astro.config.mjs`. The `build` script runs both and copies Starlight output into `dist/docs/`.
29+
1. **Main marketing site** (`src/`) — Astro + React + Tailwind. Single-page landing at `/`. Configured in root `astro.config.mjs`.
30+
2. **Documentation site** (`starlight-docs/`) — Astro Starlight. Served at `/docs/`. Has its own `package.json` and `astro.config.mjs`. The `build` script runs both and copies Starlight output into `dist/docs/`.
3131

32-
Both sites use `base: '/opensearch-agentops-website'` (or `/opensearch-agentops-website/docs`) for GitHub Pages deployment. All internal links must respect this base path.
32+
Both sites use `base: '/'` (or `/docs`) for custom domain deployment at `observability.opensearch.org`. All internal links must respect this base path.
3333

3434
### Component Patterns
3535

docs/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
[![CI](https://github.com/opensearch-project/observability-stack/actions/workflows/ci.yml/badge.svg)](https://github.com/opensearch-project/observability-stack/actions/workflows/ci.yml)
44
[![Deploy](https://github.com/opensearch-project/observability-stack/actions/workflows/deploy.yml/badge.svg)](https://github.com/opensearch-project/observability-stack/actions/workflows/deploy.yml)
55
[![codecov](https://codecov.io/gh/opensearch-project/observability-stack/branch/main/graph/badge.svg)](https://codecov.io/gh/opensearch-project/observability-stack)
6-
[![GitHub Pages](https://img.shields.io/badge/GitHub%20Pages-Live-success?logo=github)](https://opensearch-project.github.io/opensearch-agentops-website/)
6+
[![GitHub Pages](https://img.shields.io/badge/GitHub%20Pages-Live-success?logo=github)](https://observability.opensearch.org)
77

8-
**🌐 Live Site**: [https://opensearch-project.github.io/opensearch-agentops-website/](https://opensearch-project.github.io/opensearch-agentops-website/)
8+
**Live Site**: [https://observability.opensearch.org](https://observability.opensearch.org)
99

1010
Marketing website and documentation for OpenSearch - Observability Stack - an OpenTelemetry-native observability platform for AI agents and LLM applications.
1111

@@ -186,7 +186,7 @@ cd starlight-docs
186186
npm run dev
187187
```
188188

189-
The docs will be available at `http://localhost:4321/opensearch-agentops-website/docs/`
189+
The docs will be available at `http://localhost:4321/docs/`
190190

191191
## Contributing
192192

docs/astro.config.mjs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ import react from '@astrojs/react';
88

99
// https://astro.build/config
1010
export default defineConfig({
11-
site: 'https://opensearch-project.github.io',
12-
base: '/observability-stack',
11+
site: 'https://observability.opensearch.org',
12+
base: '/',
1313
integrations: [sitemap(), react()],
1414
vite: {
1515
plugins: [tailwindcss()],

docs/public/CNAME

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
observability.opensearch.org

docs/src/components/CTASection.astro

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434

3535
<!-- Secondary CTA: View Docs -->
3636
<a
37-
href="/opensearch-agentops-website/docs/"
37+
href="/docs/"
3838
class="px-8 py-4 bg-white/10 hover:bg-white/20 text-white font-semibold rounded-lg transition-colors duration-200 border border-white/30 backdrop-blur-sm"
3939
data-analytics="cta_final_view_docs"
4040
>

docs/src/components/CTASection.unit.test.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ describe('CTASection Component - Unit Tests', () => {
125125
Get Started
126126
</a>
127127
<a
128-
href="/opensearch-agentops-website/docs/"
128+
href="/docs/"
129129
class="px-8 py-4 bg-white/10 hover:bg-white/20 text-white font-semibold rounded-lg transition-colors duration-200 border border-white/30 backdrop-blur-sm"
130130
data-analytics="cta_final_view_docs"
131131
>
@@ -146,7 +146,7 @@ describe('CTASection Component - Unit Tests', () => {
146146
});
147147

148148
it('should render secondary CTA button', () => {
149-
const secondaryCTA = container.querySelector('a[href="/opensearch-agentops-website/docs/"]');
149+
const secondaryCTA = container.querySelector('a[href="/docs/"]');
150150

151151
expect(secondaryCTA).toBeTruthy();
152152
expect(secondaryCTA?.textContent?.trim()).toBe('View Docs');
@@ -159,9 +159,9 @@ describe('CTASection Component - Unit Tests', () => {
159159
});
160160

161161
it('should have correct href on secondary CTA', () => {
162-
const secondaryCTA = container.querySelector('a[href="/opensearch-agentops-website/docs/"]');
162+
const secondaryCTA = container.querySelector('a[href="/docs/"]');
163163

164-
expect(secondaryCTA?.getAttribute('href')).toBe('/opensearch-agentops-website/docs/');
164+
expect(secondaryCTA?.getAttribute('href')).toBe('/docs/');
165165
});
166166

167167
it('should have analytics tracking on primary CTA', () => {
@@ -171,7 +171,7 @@ describe('CTASection Component - Unit Tests', () => {
171171
});
172172

173173
it('should have analytics tracking on secondary CTA', () => {
174-
const secondaryCTA = container.querySelector('a[href="/opensearch-agentops-website/docs/"]');
174+
const secondaryCTA = container.querySelector('a[href="/docs/"]');
175175

176176
expect(secondaryCTA?.getAttribute('data-analytics')).toBe('cta_final_view_docs');
177177
});
@@ -186,7 +186,7 @@ describe('CTASection Component - Unit Tests', () => {
186186
});
187187

188188
it('should have secondary styling on secondary CTA', () => {
189-
const secondaryCTA = container.querySelector('a[href="/opensearch-agentops-website/docs/"]');
189+
const secondaryCTA = container.querySelector('a[href="/docs/"]');
190190

191191
expect(secondaryCTA?.classList.contains('bg-white/10')).toBe(true);
192192
expect(secondaryCTA?.classList.contains('hover:bg-white/20')).toBe(true);
@@ -217,7 +217,7 @@ describe('CTASection Component - Unit Tests', () => {
217217

218218
it('should have correct padding on CTAs', () => {
219219
const primaryCTA = container.querySelector('a[href="https://github.com/opensearch-project/observability-stack"]');
220-
const secondaryCTA = container.querySelector('a[href="/opensearch-agentops-website/docs/"]');
220+
const secondaryCTA = container.querySelector('a[href="/docs/"]');
221221

222222
expect(primaryCTA?.classList.contains('px-8')).toBe(true);
223223
expect(primaryCTA?.classList.contains('py-4')).toBe(true);
@@ -227,7 +227,7 @@ describe('CTASection Component - Unit Tests', () => {
227227

228228
it('should have rounded corners on CTAs', () => {
229229
const primaryCTA = container.querySelector('a[href="https://github.com/opensearch-project/observability-stack"]');
230-
const secondaryCTA = container.querySelector('a[href="/opensearch-agentops-website/docs/"]');
230+
const secondaryCTA = container.querySelector('a[href="/docs/"]');
231231

232232
expect(primaryCTA?.classList.contains('rounded-lg')).toBe(true);
233233
expect(secondaryCTA?.classList.contains('rounded-lg')).toBe(true);

docs/src/components/Hero.astro

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ import { CyclingTagline } from './CyclingTagline';
3333
<div class="flex flex-col sm:flex-row gap-4 justify-center lg:justify-start items-center">
3434
<!-- Primary CTA -->
3535
<a
36-
href={`${import.meta.env.BASE_URL}/docs/`}
36+
href="/docs/"
3737
class="cta-primary px-8 py-4 bg-gradient-to-r from-purple-600 to-pink-600 hover:from-purple-500 hover:to-pink-500 text-white font-bold rounded-lg transition-all duration-200 shadow-lg shadow-purple-500/50 hover:shadow-purple-500/70 hover:scale-105 backdrop-blur-sm"
3838
data-analytics="cta_hero_view_docs"
3939
>

docs/src/components/Hero.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/**
22
* Property-based tests for Hero component
3-
* Feature: opensearch-agentops-website
3+
* Feature: observability-stack
44
*/
55

66
import { describe, it, expect, beforeEach, afterEach } from 'vitest';

docs/src/components/Hero.unit.test.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,7 @@ describe('Hero Component - Unit Tests', () => {
206206
<section id="hero">
207207
<div class="flex flex-col sm:flex-row gap-4 justify-center items-center">
208208
<a
209-
href="/opensearch-agentops-website/docs/"
209+
href="/docs/"
210210
class="px-8 py-4 bg-gradient-to-r from-purple-600 to-pink-600 text-white font-bold rounded-lg"
211211
data-analytics="cta_hero_view_docs"
212212
>
@@ -229,20 +229,20 @@ describe('Hero Component - Unit Tests', () => {
229229
});
230230

231231
it('should render "View Docs" primary CTA', () => {
232-
const cta = container.querySelector('a[href="/opensearch-agentops-website/docs/"]');
232+
const cta = container.querySelector('a[href="/docs/"]');
233233

234234
expect(cta).toBeTruthy();
235235
expect(cta?.textContent?.trim()).toBe('View Docs');
236236
});
237237

238238
it('should have correct href for primary CTA', () => {
239-
const cta = container.querySelector('a[href="/opensearch-agentops-website/docs/"]');
239+
const cta = container.querySelector('a[href="/docs/"]');
240240

241-
expect(cta?.getAttribute('href')).toBe('/opensearch-agentops-website/docs/');
241+
expect(cta?.getAttribute('href')).toBe('/docs/');
242242
});
243243

244244
it('should have primary styling on "View Docs" button', () => {
245-
const cta = container.querySelector('a[href="/opensearch-agentops-website/docs/"]');
245+
const cta = container.querySelector('a[href="/docs/"]');
246246

247247
expect(cta?.classList.contains('text-white')).toBe(true);
248248
expect(cta?.classList.contains('font-bold')).toBe(true);
@@ -276,7 +276,7 @@ describe('Hero Component - Unit Tests', () => {
276276
});
277277

278278
it('should have analytics tracking attributes on both CTAs', () => {
279-
const primaryCTA = container.querySelector('a[href="/opensearch-agentops-website/docs/"]');
279+
const primaryCTA = container.querySelector('a[href="/docs/"]');
280280
const secondaryCTA = container.querySelector('a[href="https://github.com/opensearch-project/observability-stack"]');
281281

282282
expect(primaryCTA?.getAttribute('data-analytics')).toBe('cta_hero_view_docs');

0 commit comments

Comments
 (0)