SWC-5595: point directly to rest docs site or new user docs site

emmanmills · May 12, 2021 · 1bd3006 · 1bd3006
1 parent 2d93754
commit 1bd3006
Show file tree

Hide file tree

Showing 82 changed files with 185 additions and 185 deletions.
diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@ This project helps you integrate your app with the Synapse API backend.
 
 [See the available Components](https://sage-bionetworks.github.io/Synapse-React-Client/)
 
-[Getting started](http://docs.synapse.org/articles/getting_started.html) with Synapse.
+[Getting started](https://help.synapse.org/docs/Getting-Started.2055471150.html) with Synapse.
 
 [Synapse.org](https://www.synapse.org/) is a client written for the Synapse platform.
 

diff --git a/introduction.md b/introduction.md
@@ -5,7 +5,7 @@
 
 This project helps you integrate your app with the Synapse API backend by offering a number of pre-built react components.
 
-[Getting started](http://docs.synapse.org/articles/getting_started.html) with Synapse.
+[Getting started](https://help.synapse.org/docs/Getting-Started.2055471150.html) with Synapse.
 
 [Synapse.org](https://www.synapse.org/) is a client written for the Synapse platform.
 

diff --git a/src/__tests__/lib/utils/SynapseClient.test.tsx b/src/__tests__/lib/utils/SynapseClient.test.tsx
@@ -18,7 +18,7 @@ describe('it works at integration level testing', () => {
     ).catch((error) => {
       expect(error.status).toEqual(404)
       expect(error.reason).toEqual(
-        'GET was not found. Please reference API documentation at https://docs.synapse.org/rest/',
+        'GET was not found. Please reference API documentation at https://rest-docs.synapse.org/rest/',
       )
     })
   })

diff --git a/src/lib/containers/AccountLevelBadge.tsx b/src/lib/containers/AccountLevelBadge.tsx
@@ -79,7 +79,7 @@ export const AccountLevelBadge: React.FunctionComponent<AccountLevelBadgeProps>
           className="AccountLevelBadge__body__moreInfoLink"
           target="_blank"
           rel="noopener noreferrer"
-          href="https://docs.synapse.org/articles/accounts_certified_users_and_profile_validation.html"
+          href="https://help.synapse.org/docs/User-Types.2007072795.html"
         >
           Learn more
         </a>

diff --git a/src/lib/containers/CardContainerLogic.tsx b/src/lib/containers/CardContainerLogic.tsx
@@ -169,7 +169,7 @@ export default class CardContainerLogic extends React.Component<
    * Grab the next page of data, pulling in 25 more rows.
    *
    * @param {*} queryRequest Query request as specified by
-   *                         https://docs.synapse.org/rest/org/sagebionetworks/repo/model/table/Query.html
+   *                         https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/table/Query.html
    * @memberof QueryWrapper
    */
   public async getNextPageOfData(queryRequest: QueryBundleRequest) {
@@ -194,7 +194,7 @@ export default class CardContainerLogic extends React.Component<
    * Execute the initial query passed into the component
    *
    * @param {*} queryRequest Query request as specified by
-   *                         https://docs.synapse.org/rest/org/sagebionetworks/repo/model/table/Query.html
+   *                         https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/table/Query.html
    * @memberof QueryWrapper
    */
   public executeInitialQueryRequest() {

diff --git a/src/lib/containers/QueryWrapper.tsx b/src/lib/containers/QueryWrapper.tsx
@@ -233,7 +233,7 @@ export default class QueryWrapper extends React.Component<
    * Execute the given query
    *
    * @param {*} queryRequest Query request as specified by
-   *                         https://docs.synapse.org/rest/org/sagebionetworks/repo/model/table/Query.html
+   *                         https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/table/Query.html
    * @memberof QueryWrapper
    */
   public executeQueryRequest(queryRequest: QueryBundleRequest) {
@@ -285,7 +285,7 @@ export default class QueryWrapper extends React.Component<
    * Grab the next page of data, pulling in 25 more rows.
    *
    * @param {*} queryRequest Query request as specified by
-   *                         https://docs.synapse.org/rest/org/sagebionetworks/repo/model/table/Query.html
+   *                         https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/table/Query.html
    * @memberof QueryWrapper
    */
   public async getNextPageOfData(queryRequest: QueryBundleRequest) {
@@ -310,7 +310,7 @@ export default class QueryWrapper extends React.Component<
    * Execute the initial query passed into the component
    *
    * @param {*} queryRequest Query request as specified by
-   *                         https://docs.synapse.org/rest/org/sagebionetworks/repo/model/table/Query.html
+   *                         https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/table/Query.html
    * @memberof QueryWrapper
    */
   public executeInitialQueryRequest(

diff --git a/src/lib/containers/SynapseHomepage.tsx b/src/lib/containers/SynapseHomepage.tsx
@@ -70,7 +70,7 @@ export const SynapseHomepage: React.FunctionComponent<SynapseHomepageProps> = ({
                 <Button
                   onClick={() =>
                     window.open(
-                      'https://docs.synapse.org/articles/getting_started.html',
+                      'https://help.synapse.org/docs/Getting-Started.2055471150.html',
                       '_blank',
                       'noopener',
                     )
@@ -238,7 +238,7 @@ export const SynapseHomepage: React.FunctionComponent<SynapseHomepageProps> = ({
               variant="primary"
               onClick={() =>
                 window.open(
-                  'https://docs.synapse.org/articles/governance.html',
+                  'https://help.synapse.org/docs/Governance-Overview.2009597114.html',
                   '_blank',
                   'noopener',
                 )
@@ -301,7 +301,7 @@ export const SynapseHomepage: React.FunctionComponent<SynapseHomepageProps> = ({
             <Button
               onClick={() =>
                 window.open(
-                  'https://docs.synapse.org/articles/api_documentation.html',
+                  'https://help.synapse.org/docs/API-Documentation.1985184035.html',
                   '_blank',
                   'noopener',
                 )
@@ -444,7 +444,7 @@ export const SynapseHomepage: React.FunctionComponent<SynapseHomepageProps> = ({
                 <Button
                   onClick={() =>
                     window.open(
-                      'https://docs.synapse.org/articles/getting_started.html',
+                      'https://help.synapse.org/docs/Getting-Started.2055471150.html',
                       '_blank',
                       'noopener',
                     )

diff --git a/src/lib/containers/TermsAndConditions.tsx b/src/lib/containers/TermsAndConditions.tsx
@@ -29,7 +29,7 @@ const tcList: tcItem[] = [
     <li>Respects other viewpoints and ideas</li>
     <li>Shows empathy and kindness when interacting with others</li>
     </ul>
-Please refer to our full <a target="_blank" href="https://docs.synapse.org/articles/governance.html#synapse-community-standards">Synapse Community Standards</a>.`,
+Please refer to our full <a target="_blank" href="https://help.synapse.org/docs/Governance-Overview.2009597114.html#GovernanceOverview-SynapseCodeofConduct">Synapse Code of Conduct</a>.`,
   },
   {
     icon: lockSvg,

diff --git a/src/lib/containers/access_requirement_list/managedACTAccess/RequestDataAccessStep2.tsx b/src/lib/containers/access_requirement_list/managedACTAccess/RequestDataAccessStep2.tsx
@@ -415,7 +415,7 @@ const RequestDataAccessStep2: React.FC<RequestDataAccessStep2Props> = props => {
           </Form.Label><br/>
           <span>This list should match those listed on your DUC.</span><br/>
           <span className={"requester-label"}>All data requesters must have a validated user profile.</span>
-          <a href={"https://docs.synapse.org/articles/accounts_certified_users_and_profile_validation.html#validated-profile"} target={"_blank"} rel={"noreferrer"}>
+          <a href={"https://help.synapse.org/docs/User-Types.2007072795.html#UserAccountTiers-ValidatedUsers"} target={"_blank"} rel={"noreferrer"}>
             <IconSvg
               options={{
                 icon: 'info'

diff --git a/src/lib/containers/table/table-top/DownloadLoginModal.tsx b/src/lib/containers/table/table-top/DownloadLoginModal.tsx
@@ -26,15 +26,15 @@ export const DownloadLoginModal: React.FunctionComponent<DownloadLoginModalProps
         <p>
           To find out more see&nbsp;
           <a
-            href="https://docs.synapse.org/articles/user_profiles.html"
+            href="https://help.synapse.org/docs/Managing-your-account.2055405596.html"
             target="_blank"
             rel="noopener noreferrer"
           >
             User Accounts
           </a>
           <span> and </span>
           <a
-            href="https://docs.synapse.org/articles/governance.html"
+            href="https://help.synapse.org/docs/Governance-Overview.2009597114.html"
             rel="noopener noreferrer"
             target="_blank"
           >

diff --git a/src/lib/containers/table/table-top/ProgrammaticOptions.tsx b/src/lib/containers/table/table-top/ProgrammaticOptions.tsx
@@ -77,7 +77,7 @@ function ProgrammaticOptions({
           instructions are available
           <a
             className="ProgrammaticOptions__docslink"
-            href="https://docs.synapse.org/articles/tutorial-download-data-portal.html#command-line"
+            href="https://help.synapse.org/docs/Download-Data-Programmatically-from-a-Portal.1982693983.html"
             target="_blank"
             rel="noopener noreferrer"
           >

diff --git a/src/lib/containers/widgets/SynapseImage.tsx b/src/lib/containers/widgets/SynapseImage.tsx
@@ -46,7 +46,7 @@ class SynapseImage extends React.Component<
     const { token, synapseId } = this.props
     if (synapseId) {
       getEntity<FileEntity>(token, synapseId).then(
-        // https://docs.synapse.org/rest/org/sagebionetworks/repo/model/FileEntity.html
+        // https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/FileEntity.html
         (data: FileEntity) => {
           const fileHandleAssociationList = [
             {