Skip to content

Commit 679b07d

Browse files
committed
Some things work except json-docs aren't copying
1 parent 937f72b commit 679b07d

File tree

10 files changed

+200
-176
lines changed

10 files changed

+200
-176
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,16 @@ yarn start --project ember-data --version <VERSION_TO_REPLACE> --ignorePreviousl
122122
yarn start --clean --max_old_space_size=8192
123123
```
124124

125+
## Running from GitHub
126+
127+
```
128+
git clone [email protected]:ember-learn/ember-api-docs-data.git
129+
git clone [email protected]:emberjs/ember.js.git && cd ember.js && yarn install
130+
git clone [email protected]:ember-learn/ember-jsonapi-docs.git && cd ember-jsonapi-docs.git && yarn install
131+
yarn gen --project ember --version "3.24.0"
132+
yarn start --project ember --version "3.24.0"
133+
```
134+
125135
## Backing Up Docs
126136

127137
If you plan to run a major migration, back up all the content to a timestamped folder in the Amazon S3 bucket.

app.json

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,4 @@
11
{
2-
"env": {
3-
"AWS_ACCESS_KEY_ID": {
4-
"required": true
5-
},
6-
"AWS_SECRET_ACCESS_KEY": {
7-
"required": true
8-
},
9-
"AWS_SHOULD_PUBLISH": {
10-
"required": true,
11-
"default": "yes"
12-
}
13-
},
142
"buildpacks": [
153
{
164
"url": "heroku/nodejs"

backup.js

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
import { backupExistingFolders } from './lib/s3-sync'
2-
import 'hard-rejection/register'
3-
;(async () => {
4-
await backupExistingFolders()
5-
console.log('\n\n')
6-
console.log('Done!')
7-
})()
1+
// import { backupExistingFolders } from './lib/s3-sync'
2+
// import 'hard-rejection/register'
3+
// ;(async () => {
4+
// await backupExistingFolders()
5+
// console.log('\n\n')
6+
// console.log('Done!')
7+
// })()

generate-local.js

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
import chalk from 'chalk'
22
import commandExists from 'command-exists'
33
import execa from 'execa'
4-
import { copyFileSync, existsSync, mkdirpSync, removeSync } from 'fs-extra'
4+
import { copyFileSync, ensureDirSync, ensureFileSync, existsSync, mkdirpSync, removeSync } from 'fs-extra'
55
import minimist from 'minimist'
66
import path from 'path'
77
import 'hard-rejection/register'
88

9+
const docsPath = '../ember-api-docs-data';
10+
911
const argv = minimist(process.argv.slice(2))
1012

1113
const { project, version } = argv
@@ -61,7 +63,9 @@ const runCmd = async (cmd, path) => {
6163

6264
await runCmd(project === 'ember' ? 'yarn docs' : 'yarn workspace ember-data docs', projDirPath)
6365

64-
const projYuiDocFile = `tmp/s3-docs/v${version}/${project}-docs.json`
66+
let destination = `${docsPath}/s3-docs/v${version}/${project}-docs.json`
67+
ensureFileSync(destination)
68+
const projYuiDocFile = destination;
6569
removeSync(projYuiDocFile)
6670
removeSync(`tmp/json-docs/${project}/${version}`)
6771

lib/fetch-yui-docs.js

Lines changed: 37 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ import mkdirp from 'mkdirp'
66
import pkgVersions from 'pkg-versions'
77
import { all, resolve } from 'rsvp'
88

9+
const docsPath = '../ember-api-docs-data';
10+
911
let filterValidVersions = (specificDocsVersion, ignorePreviouslyIndexedDoc) => version => {
1012
let isCompatibleVersion =
1113
// compareVersions(version, '3.4.1') !== -1 &&
@@ -18,48 +20,48 @@ let filterValidVersions = (specificDocsVersion, ignorePreviouslyIndexedDoc) => v
1820
}
1921
}
2022

21-
async function fetchYuiDocsFromNpm(projects, projectName, filterValidVersionsForRequestedDocs) {
22-
if (!projects.includes(projectName)) {
23-
return resolve()
24-
}
23+
// async function fetchYuiDocsFromNpm(projects, projectName, filterValidVersionsForRequestedDocs) {
24+
// if (!projects.includes(projectName)) {
25+
// return resolve()
26+
// }
2527

26-
let projectPkgMap = {
27-
ember: 'ember-source',
28-
'ember-data': 'ember-data',
29-
}
30-
let versions = await pkgVersions(projectPkgMap[projectName])
31-
let versionsToProcess = [...versions].filter(filterValidVersionsForRequestedDocs)
28+
// let projectPkgMap = {
29+
// ember: 'ember-source',
30+
// 'ember-data': 'ember-data',
31+
// }
32+
// let versions = await pkgVersions(projectPkgMap[projectName])
33+
// let versionsToProcess = [...versions].filter(filterValidVersionsForRequestedDocs)
3234

33-
let getProjectFileUrl
35+
// let getProjectFileUrl
3436

35-
if (projectName === 'ember') {
36-
getProjectFileUrl = v => `https://unpkg.com/ember-source@${v}/docs/data.json`
37-
} else {
38-
getProjectFileUrl = v => `https://unpkg.com/ember-data@${v}/dist/docs/data.json`
39-
}
37+
// if (projectName === 'ember') {
38+
// getProjectFileUrl = v => `https://unpkg.com/ember-source@${v}/docs/data.json`
39+
// } else {
40+
// getProjectFileUrl = v => `https://unpkg.com/ember-data@${v}/dist/docs/data.json`
41+
// }
4042

41-
return await all(
42-
versionsToProcess.map(async v => {
43-
let url = getProjectFileUrl(v)
44-
let targetDir = `tmp/s3-docs/v${v}`
45-
let targetFile = `${targetDir}/${projectName}-docs.json`
43+
// return await all(
44+
// versionsToProcess.map(async v => {
45+
// let url = getProjectFileUrl(v)
46+
// let targetDir = `${docsPath}/s3-docs/v${v}`
47+
// let targetFile = `${targetDir}/${projectName}-docs.json`
4648

47-
try {
48-
if (fs.existsSync(targetFile)) {
49-
return targetFile
50-
}
51-
let data = await download(url)
49+
// try {
50+
// if (fs.existsSync(targetFile)) {
51+
// return targetFile
52+
// }
53+
// let data = await download(url)
5254

53-
mkdirp.sync(targetDir)
54-
fs.writeFileSync(targetFile, data)
55+
// mkdirp.sync(targetDir)
56+
// fs.writeFileSync(targetFile, data)
5557

56-
return targetFile
57-
} catch (e) {
58-
console.error(`Failed to download ${url} ${e}`)
59-
}
60-
})
61-
)
62-
}
58+
// return targetFile
59+
// } catch (e) {
60+
// console.error(`Failed to download ${url} ${e}`)
61+
// }
62+
// })
63+
// )
64+
// }
6365

6466
export default async function fetchYuiDocs(
6567
projects,

lib/fix-borked-yuidoc-files.js

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,16 @@ import { normalizeYuiDocClass } from './yuidoc-fixer/normalize-yui-doc-class'
1313
* fixing it here
1414
* @param {*} file
1515
*/
16+
17+
const docsPath = '../ember-api-docs-data';
18+
1619
export default async function fixBorkedYuidocFiles(file) {
1720
if (!file) {
1821
return
1922
}
2023

2124
const version = file
22-
.replace('tmp/s3-docs/v', '')
25+
.replace(`${docsPath}/s3-docs/v`, '')
2326
.replace('/ember-docs.json', '')
2427
.replace('/ember-data-docs.json', '')
2528

lib/read-docs.js

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ import { dasherize } from 'inflected'
44
import { get as deepGet } from 'lodash'
55
import { getLatestPatchVersions } from './get-latest-patch-versions'
66

7+
const docsPath = '../ember-api-docs-data';
8+
79
export default function readDocs(
810
projects,
911
specificVersion = '',
@@ -26,10 +28,10 @@ export default function readDocs(
2628
)
2729
}
2830

29-
let folders = glob.sync(`tmp/s3-docs/v${specificVersion}*/${dasherize(projectName)}-docs.json`)
31+
let folders = glob.sync(`${docsPath}/s3-docs/v${specificVersion}*/${dasherize(projectName)}-docs.json`)
3032

3133
let availableSourceVersions = folders.map(x =>
32-
x.replace('tmp/s3-docs/v', '').replace(`/${projectName}-docs.json`, '')
34+
x.replace(`${docsPath}/s3-docs/v`, '').replace(`/${projectName}-docs.json`, '')
3335
)
3436

3537
if (!runClean) {
@@ -43,7 +45,7 @@ export default function readDocs(
4345
if (!prevIndexedVersions.includes(f) || ignorePreviouslyIndexedDoc) {
4446
return f
4547
} else {
46-
let version = f.replace('tmp/s3-docs/v', '').replace(`/${projectName}-docs.json`, '')
48+
let version = f.replace(`${docsPath}/s3-docs/v`, '').replace(`/${projectName}-docs.json`, '')
4749
console.log(`${projectName}-${version} has already been indexed in json-docs`)
4850
}
4951
})
@@ -56,7 +58,7 @@ export default function readDocs(
5658
let data
5759

5860
try {
59-
data = await fs.readJSON(`tmp/s3-docs/v${version}/${projectName}-docs.json`)
61+
data = await fs.readJSON(`${docsPath}/s3-docs/v${version}/${projectName}-docs.json`)
6062
return { project: projectName, version, data }
6163
} catch (e) {
6264
console.error(version)

lib/rev-docs.js

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,22 @@ import { Promise } from 'rsvp'
55
import { basename as getFileName } from 'path'
66
import { isArray } from 'lodash/lang'
77
import { singularize } from 'inflected'
8+
import path from 'path';
89
const glob = require('glob')
910

11+
const docsPath = '../ember-api-docs-data';
12+
1013
function revProjVersionFiles(project, ver) {
1114
let opProgress = ora(`Revving ${project}:${ver} files`).start()
12-
const projDocsDir = `tmp/json-docs/${project}`
13-
const revIndexFolder = 'tmp/rev-index'
15+
const projDocsDir = path.resolve(`tmp/json-docs/${project}`)
16+
const revIndexFolder = path.resolve(`${docsPath}/rev-index`);
1417

1518
fs.mkdirpSync(revIndexFolder)
19+
const destination = `${revIndexFolder}/${project}-${ver}.json`
1620

1721
fs.copySync(
1822
`${projDocsDir}/${ver}/project-versions/${project}-${ver}.json`,
19-
`${revIndexFolder}/${project}-${ver}.json`
23+
destination
2024
)
2125

2226
opProgress.text = `Revving ${project}:${ver}`

0 commit comments

Comments
 (0)