Skip to content

Commit faf4697

Browse files
committed
update_toc.ps1 g2g. added a help for those who may be confused
1 parent 9211afb commit faf4697

File tree

2 files changed

+20
-2
lines changed

2 files changed

+20
-2
lines changed

FOR_THOSE_WHO_ARE_LOST.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# To those looking for the code2yml or repo.js
2+
3+
Those don't exist anymore. We apologize if you were not notified, but it was difficult to ascertain those who would be impacted by this change.
4+
5+
This repository has swapped to a maven-package based configuration system. Instead of pulling in pure source, we pull down a maven SOURCES package a build javadoc from that. Check the `packages.json` to see the configuration. It should be quite understandable.
6+
7+
- The `docs-ref-autogen` and `docs-ref-mapping` present in root are associated with the `stable` moniker.
8+
- The `preview` is associated with `preview` moniker
9+
- `legacy` is a static _snapshot in time_ of the documentation prior to this transition. This is an effort to mitigate and pain while remedies are implemented.
10+
11+
Additionally:
12+
13+
- This method is far more compatible with the upcoming versioning changes
14+
- Much more easily maintained
15+
- The docs team would prefer to sunset the source-based implementation as soon as possible
16+
17+
Contact scbedd for additional details! Apologies for the difficulty and surprise!

update_toc.ps1

+3-2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ Param(
44
)
55

66
$results = Get-Content "$TargetFolder/docs-ref-autogen/toc.yml","legacy-docs-toc-merge/toc.yml"
7-
# needs to be another
7+
# separate operations otherwise pshell leaves the file open and the set-content fails
88
$results | Set-Content "$TargetFolder/docs-ref-autogen/toc.yml"
9-
Copy-Item -Path "$TargetFolder/legacy-docs-toc-merge/*" -Destination "$TargetFolder/docs-ref-autogen"
9+
10+
Copy-Item -Path "$TargetFolder/legacy-docs-toc-merge/*" -Exclude @("toc.yml") -Destination "$TargetFolder/docs-ref-autogen"

0 commit comments

Comments
 (0)