Skip to content

Commit 7dcb1b4

Browse files
authored
Update README.md
1 parent 3555fd6 commit 7dcb1b4

File tree

1 file changed

+2
-90
lines changed

1 file changed

+2
-90
lines changed

README.md

Lines changed: 2 additions & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -1,91 +1,3 @@
1-
# Adobe Developer Console Documentation
1+
# Documentation
22

3-
Adobe Developer Console documentation site deployed to EDS.
4-
The production address is https://developer.adobe.com/developer-console/docs/
5-
6-
## Quick Start
7-
8-
For local development, you need to start three servers:
9-
10-
1. **Main dev server** (this repo):
11-
```bash
12-
npm run dev
13-
```
14-
15-
2. **ADP Devsite** ([adp-devsite](https://github.com/AdobeDocs/adp-devsite)):
16-
```bash
17-
git clone https://github.com/AdobeDocs/adp-devsite
18-
cd adp-devsite
19-
npm install
20-
npm run dev
21-
```
22-
23-
3. **Runtime connector** ([devsite-runtime-connector](https://github.com/aemsites/devsite-runtime-connector)):
24-
```bash
25-
git clone https://github.com/aemsites/devsite-runtime-connector
26-
cd devsite-runtime-connector
27-
npm install
28-
npm run dev
29-
```
30-
31-
Once all three servers are running, navigate to http://localhost:3000
32-
33-
## Commands
34-
35-
**Development**
36-
- `npm run dev` - Start local server (requires other services above)
37-
38-
**Content Management**
39-
- `npm run buildNavigation` - Generate navigation structure (one-time Gatsby migration only)
40-
- `npm run buildRedirections` - Build URL redirections (one-time Gatsby migration only)
41-
- `npm run renameFiles` - Rename files to Adobe conventions
42-
- `npm run normalizeLinks` - Normalize internal/external links
43-
44-
**Validation**
45-
- `npm run lint` - Run linting checks
46-
47-
**Site Features**
48-
- `npm run buildSiteWideBanner` - Generate site-wide banner
49-
50-
*All commands use `@AdobeDocs/adp-devsite-utils` for standardized tooling.*
51-
52-
## Linting
53-
54-
**Automated**: Runs on PRs when `src/pages/**` files change
55-
**Manual**: `npm run lint`
56-
57-
Validates markdown syntax, links, content structure, and Adobe style guidelines.
58-
59-
**Troubleshooting**: If pages are not showing up as expected, check lint warnings to identify potential issues.
60-
61-
## Navigation
62-
63-
To update navigation structure:
64-
1. Edit `src/pages/config.md` directly
65-
66-
*Note: `npm run buildNavigation` is only needed for initial Gatsby migration.*
67-
68-
## Redirects
69-
70-
To manage URL redirections:
71-
1. Edit `src/pages/redirects.json` directly
72-
73-
*Note: `npm run buildRedirections` is only needed for initial Gatsby migration.*
74-
75-
## Deployment
76-
77-
**Staging**:
78-
- Actions > Deployment > Run workflow
79-
- Can deploy from any branch to staging
80-
- Uses incremental builds from last commit by default
81-
- Use `deployAll` function for full rebuild if needed
82-
- **URL**: `developer-stage.adobe.com/developer-console/docs/`
83-
84-
**Production**:
85-
- Automatically deploys from `main` branch
86-
- Uses incremental builds from last commit
87-
- **URL**: `developer.adobe.com/developer-console/docs/`
88-
89-
## Support
90-
91-
Join `#adobe-developer-website` Slack channel for help.
3+
Please see the [centralized README](https://github.com/AdobeDocs/adp-devsite-utils/blob/main/README.md).

0 commit comments

Comments
 (0)