Feature/base url for docs (#783)

* add base url option for docs

package.json

@@ -3,7 +3,7 @@
   "version": "2.3.0",
   "license": "Apache License 2.0",
   "config": {
-    "webservice_version": "1.7.0-beta.6"
+    "webservice_version": "1.7.0-rc.1"
   },
   "scripts": {
     "ng": "npx ng",

src/app/configuration.service.ts

@@ -67,6 +67,8 @@ export class ConfigurationService {
     Dockstore.CWL_VISUALIZER_URI = config.cwlVisualizerUri;
 
     Dockstore.GITHUB_APP_INSTALLATION_URL = config.gitHubAppInstallationUrl;
+
+    Dockstore.DOCUMENTATION_URL = config.documentationUrl;
   }
 
   /**

src/app/container/versions/versions.component.html

@@ -30,7 +30,10 @@
             >
               Version
             </label>
-            <a *ngIf="!publicPage" href="http://docs.dockstore.org/faq/#what-is-a-default-version-of-a-tool-or-workflow" target="_blank"
+            <a
+              *ngIf="!publicPage"
+              href="{{ Dockstore.DOCUMENTATION_URL }}/faq.html#what-is-a-default-version-of-a-tool-or-workflow"
+              target="_blank"
               ><mat-icon>info</mat-icon></a
             >
             <fa-icon class="pull-right" [icon]="getIconClass('name')" (click)="clickSortColumn('name')"></fa-icon>

src/app/container/versions/versions.component.ts

@@ -29,6 +29,7 @@ import { DockstoreTool } from '../../shared/swagger/model/dockstoreTool';
 import { Tag } from '../../shared/swagger/model/tag';
 import { Versions } from '../../shared/versions';
 import { AddTagComponent } from '../add-tag/add-tag.component';
+import { Dockstore } from '../../shared/dockstore.model';
 
 @Component({
   selector: 'app-versions-container',
@@ -37,6 +38,7 @@ import { AddTagComponent } from '../add-tag/add-tag.component';
 })
 export class VersionsContainerComponent extends Versions implements OnInit {
   @Input() versions: Array<any>;
+  Dockstore = Dockstore;
   versionTag: Tag;
   public DockstoreToolType = DockstoreTool;
   @Input() set selectedVersion(value: Tag) {

src/app/footer/footer.component.html

@@ -21,7 +21,12 @@
         <ul class="footer-list m-0">
           <li class="m-0">Dockstore</li>
           <li class="m-0">
-            <a href="https://docs.dockstore.org/docs/" target="_blank" rel="noopener noreferrer" class="footer-link">
+            <a
+              href="{{ Dockstore.DOCUMENTATION_URL }}/dockstore-introduction.html"
+              target="_blank"
+              rel="noopener noreferrer"
+              class="footer-link"
+            >
               <small>About</small>
             </a>
           </li>

src/app/footer/footer.component.ts

@@ -33,6 +33,7 @@ export class FooterComponent extends Base implements OnInit {
   tag: string;
   public prod = true;
   public dsServerURI: any;
+  Dockstore = Dockstore;
 
   constructor(private metadataService: MetadataService) {
     super();

src/app/home-page/home-logged-out/home.component.html

@@ -170,7 +170,12 @@ <h3 class="text-center">Local launch</h3>
     <h3 class="text-center">Next steps</h3>
 
     <div fxLayout="row wrap" fxLayout.lt-md="column" fxLayoutAlign="center center" fxLayoutGap="20px" class="mb-4">
-      <a mat-stroked-button href="https://docs.dockstore.org/docs/user-tutorials" target="_blank" rel="noopener noreferrer">
+      <a
+        mat-stroked-button
+        href="{{ Dockstore.DOCUMENTATION_URL }}/end-user-topics/end-user-topics.html"
+        target="_blank"
+        rel="noopener noreferrer"
+      >
         Getting Started Guide
       </a>
       <button mat-stroked-button routerLink="/organizations" (click)="scrollToTop()">

src/app/home-page/home-logged-out/home.component.ts

@@ -21,6 +21,7 @@ import { Observable, Subject } from 'rxjs';
 import { User } from '../../shared/swagger/model/user';
 import { TwitterService } from '../../shared/twitter.service';
 import { UserQuery } from '../../shared/user/user.query';
+import { Dockstore } from '../../shared/dockstore.model';
 
 /**
  * Simple youtube iframe component, too simple to have its own file
@@ -46,6 +47,7 @@ export class HomeComponent implements OnInit, AfterViewInit {
   public user$: Observable<User>;
   public selectedTab = 'toolTab';
   protected ngUnsubscribe: Subject<{}> = new Subject();
+  Dockstore = Dockstore;
 
   @ViewChild('youtube') youtube: ElementRef;
 

src/app/home-page/logged-in-banner/logged-in-banner.component.html

@@ -12,7 +12,7 @@ <h2 class="unpadded-caption">Docker Tools and Workflows for the Sciences</h2>
     />
   </div>
   <div class="m-2" fxLayout="column" fxLayoutAlign="center" fxLayoutGap="0.5rem">
-    <a mat-flat-button color="accent" href="https://docs.dockstore.org/docs/#about-the-dockstore" class="big-button">
+    <a mat-flat-button color="accent" href="{{ Dockstore.DOCUMENTATION_URL }}/dockstore-introduction.html" class="big-button">
       About
     </a>
     <button mat-flat-button color="accent" routerLink="/quick-start" class="big-button">Quickstart</button>

src/app/home-page/logged-in-banner/logged-in-banner.component.ts

@@ -1,12 +1,14 @@
 import { Component } from '@angular/core';
 import { HomePageService } from 'app/home-page/home-page.service';
+import { Dockstore } from '../../shared/dockstore.model';
 
 @Component({
   selector: 'app-logged-in-banner',
   templateUrl: './logged-in-banner.component.html',
   styleUrls: ['./logged-in-banner.component.scss']
 })
 export class LoggedInBannerComponent {
+  Dockstore = Dockstore;
   constructor(private homePageService: HomePageService) {}
 
   goToSearch(searchValue: string) {

src/app/home-page/old-home-page/old-home-page.component.html

@@ -75,7 +75,7 @@ <h4 class="title caption">
               <a mat-raised-button color="accent" routerLink="onboarding">Setup Account <mat-icon>chevron_right</mat-icon></a>
             </div>
             <div class="col-sm-6 col-xs-12 col-md-12">
-              <a mat-raised-button color="accent" href="https://docs.dockstore.org/news/"
+              <a mat-raised-button color="accent" href="{{ Dockstore.DOCUMENTATION_URL }}/news/"
                 >News and Events <mat-icon>chevron_right</mat-icon></a
               >
             </div>

src/app/home-page/old-home-page/old-home-page.component.ts

@@ -23,6 +23,8 @@ import { TwitterService } from 'app/shared/twitter.service';
 import { UserQuery } from 'app/shared/user/user.query';
 import { TabDirective } from 'ngx-bootstrap/tabs';
 import { Observable } from 'rxjs';
+import { Dockstore } from '../../shared/dockstore.model';
+
 /**
  * Simple youtube iframe component, too simple to have its own file
  *
@@ -46,6 +48,7 @@ export class OldHomePageComponent implements OnInit, AfterViewInit {
   public browseWorkflowsTab = 'browseWorkflowsTab';
   public user$: Observable<User>;
   public selectedTab = 'toolTab';
+  Dockstore = Dockstore;
 
   @ViewChild('youtube') youtube: ElementRef;
 

src/app/loginComponents/onboarding/onboarding.component.html

@@ -69,7 +69,7 @@ <h5>Dockstore External Services</h5>
       <a
         mat-raised-button
         color="primary"
-        href="https://docs.dockstore.org/docs/prereqs/getting-started-with-docker/"
+        href="{{ Dockstore.DOCUMENTATION_URL }}/getting-started/getting-started-with-docker.html"
         class="pull-right ml-1"
         >Go to Docs<mat-icon>navigate_next</mat-icon></a
       >

src/app/loginComponents/onboarding/onboarding.component.ts

@@ -4,8 +4,8 @@ import { distinctUntilChanged, takeUntil } from 'rxjs/operators';
 
 import { ExtendedUserData, User, UsersService } from '../../shared/swagger';
 import { UserQuery } from '../../shared/user/user.query';
-import { TokenService } from '../../shared/state/token.service';
 import { TokenQuery } from '../../shared/state/token.query';
+import { Dockstore } from '../../shared/dockstore.model';
 
 @Component({
   selector: 'app-onboarding',
@@ -17,6 +17,7 @@ export class OnboardingComponent implements OnInit, OnDestroy {
   extendedUser: ExtendedUserData;
   user: User;
   ready = false;
+  Dockstore = Dockstore;
   constructor(private userQuery: UserQuery, private usersService: UsersService, private tokenService: TokenQuery) {}
   ngOnInit() {
     localStorage.setItem('page', '/onboarding');

src/app/loginComponents/onboarding/quickstart.component.html

@@ -28,7 +28,7 @@
         <button class="changePage" (click)="prevStep()"><mat-icon>chevron_left</mat-icon>Previous</button>
       </li>
       <li>
-        <a href="https://docs.dockstore.org/docs/user-tutorials/launch/">Finish<mat-icon>chevron_right</mat-icon></a>
+        <a href="{{ Dockstore.DOCUMENTATION_URL }}/end-user-topics/launch.html">Finish<mat-icon>chevron_right</mat-icon></a>
       </li>
     </ul>
   </nav>

src/app/loginComponents/onboarding/quickstart.component.ts

@@ -14,6 +14,7 @@
  *    limitations under the License.
  */
 import { Component, OnInit } from '@angular/core';
+import { Dockstore } from '../../shared/dockstore.model';
 
 @Component({
   selector: 'app-onboarding',
@@ -22,6 +23,7 @@ import { Component, OnInit } from '@angular/core';
 export class QuickStartComponent implements OnInit {
   public curStep = 1;
   public tokenSetComplete;
+  Dockstore = Dockstore;
   constructor() {}
   ngOnInit() {
     localStorage.setItem('page', '/quick-start');

src/app/navbar/navbar.component.html

@@ -26,7 +26,7 @@
         <a mat-button class="icon" (click)="resetPageNumber()" routerLink="/organizations">
           <mat-icon class="hidden-sm">people</mat-icon> Organizations
         </a>
-        <a mat-button class="icon" href="http://docs.dockstore.org/">
+        <a mat-button class="icon" href="{{ Dockstore.DOCUMENTATION_URL }}">
           <img class="site-icons-small hidden-sm" src="../assets/images/dockstore/dockstore-documentation.png" /> Docs
         </a>
         <span class="spacer"></span>
@@ -76,7 +76,7 @@
     <div class="container-fluid navbar-holder">
       <a mat-button class="icon icon-sm" routerLink="/search">Search</a>
       <a mat-button class="icon icon-sm" routerLink="/organizations">Organizations</a>
-      <a mat-button class="icon icon-sm" href="http://docs.dockstore.org/">Docs</a>
+      <a mat-button class="icon icon-sm" href="{{ Dockstore.DOCUMENTATION_URL }}">Docs</a>
     </div>
   </mat-toolbar-row>
 </mat-toolbar>

src/app/navbar/navbar.component.ts

@@ -26,6 +26,7 @@ import { PageInfo } from './../shared/models/PageInfo';
 import { PagenumberService } from './../shared/pagenumber.service';
 import { User } from './../shared/swagger/model/user';
 import { TrackLoginService } from './../shared/track-login.service';
+import { Dockstore } from '../shared/dockstore.model';
 
 @Component({
   selector: 'app-navbar',
@@ -37,6 +38,7 @@ export class NavbarComponent extends Logout implements OnInit {
   extendedUser: any;
   isExtended = false;
   devMode = devMode;
+  Dockstore = Dockstore;
   protected ngUnsubscribe: Subject<{}> = new Subject();
   private currentTOSVersion: User.TosversionEnum = User.TosversionEnum.TOSVERSION1;
   private currentPrivacyPolicyVersion: User.PrivacyPolicyVersionEnum = User.PrivacyPolicyVersionEnum.PRIVACYPOLICYVERSION25;

src/app/shared/date.service.spec.ts

@@ -20,6 +20,7 @@ import { ContainersStubService } from '../test/service-stubs';
 import { ContainersService } from './swagger/api/containers.service';
 import { ImageProviderService } from './image-provider.service';
 import { TestBed, inject } from '@angular/core/testing';
+import { Dockstore } from '../shared/dockstore.model';
 
 describe('DateService', () => {
   beforeEach(() => {
@@ -40,7 +41,7 @@ describe('DateService', () => {
     expect(service.getAgoMessage(1498675698000)).toContain(' days ago');
   }));
   it('should be getVerifiedLink', inject([DateService], (service: DateService) => {
-    expect(service.getVerifiedLink()).toEqual('https://docs.dockstore.org/faq/#what-is-a-verified-tool-or-workflow');
+    expect(service.getVerifiedLink()).toEqual(Dockstore.DOCUMENTATION_URL + '/faq.html#what-is-a-verified-tool-or-workflow');
   }));
   it('should be ISO8601Format when given number', inject([DateService], (service: DateService) => {
     expect(service.getISO8601Format(1498675698000)).toEqual('2017-06-28T18:48:18.000Z');

src/app/shared/date.service.ts

@@ -15,6 +15,7 @@
  */
 
 import { Injectable } from '@angular/core';
+import { Dockstore } from '../shared/dockstore.model';
 
 @Injectable()
 export class DateService {
@@ -40,7 +41,7 @@ export class DateService {
 
   /*Note: change this link if necessary */
   getVerifiedLink(): string {
-    return 'https://docs.dockstore.org/faq/#what-is-a-verified-tool-or-workflow';
+    return Dockstore.DOCUMENTATION_URL + '/faq.html#what-is-a-verified-tool-or-workflow';
   }
 
   getAgoMessage(timestamp: number): string | null {

src/app/shared/dockstore.model.ts

@@ -68,6 +68,8 @@ export class Dockstore {
 
   static GITHUB_APP_INSTALLATION_URL = 'will be filled in by configuration.service';
 
+  static DOCUMENTATION_URL = 'https://docs.dockstore.org';
+
   static FEATURES = {
     enableCwlViewer: true
   };

src/app/shared/private-icon/private-icon.component.ts

@@ -1,4 +1,5 @@
 import { Component, OnInit } from '@angular/core';
+import { Dockstore } from '../../shared/dockstore.model';
 
 @Component({
   selector: 'app-private-icon',
@@ -7,6 +8,6 @@ import { Component, OnInit } from '@angular/core';
 })
 export class PrivateIconComponent {
   // Change this link if necessary
-  readonly privateDocsLink = 'https://docs.dockstore.org/docs/publisher-tutorials/public-and-private-tools/';
+  readonly privateDocsLink = Dockstore.DOCUMENTATION_URL + '/advanced-topics/public-and-private-tools.html';
   constructor() {}
 }

src/app/sitemap/sitemap.component.html

@@ -42,17 +42,17 @@ <h3 class="documentation">Tools and Workflows</h3>
     <h3 class="documentation">Using Dockstore</h3>
     <ul>
       <li>
-        <a target="_blank" href="https://docs.dockstore.org/news/">
+        <a target="_blank" href="{{ Dockstore.DOCUMENTATION_URL }}/news/">
           News and Events
         </a>
       </li>
       <li>
-        <a target="_blank" href="https://docs.dockstore.org/docs/publisher-tutorials/advanced-features/">
+        <a target="_blank" href="{{ Dockstore.DOCUMENTATION_URL }}/advanced-topics/advanced-features.html">
           Advanced Features
         </a>
       </li>
       <li>
-        <a target="_blank" href="https://docs.dockstore.org/faq/">
+        <a target="_blank" href="{{ Dockstore.DOCUMENTATION_URL }}/faq.html">
           FAQ
         </a>
       </li>
@@ -77,56 +77,50 @@ <h3 class="documentation">Using Dockstore</h3>
     <h3>Adding to Dockstore</h3>
     <ul>
       <li>
-        <a
-          target="_blank"
-          href="https://docs.dockstore.org/docs/publisher-tutorials/getting-started-with-dockstore/#getting-started-with-dockstore"
-        >
+        <a target="_blank" href="{{ Dockstore.DOCUMENTATION_URL }}/getting-started/register-on-dockstore.html">
           Sign Up for Accounts
         </a>
       </li>
       <li>
-        <a target="_blank" href="https://docs.dockstore.org/docs/prereqs/getting-started-with-docker/">
+        <a target="_blank" href="{{ Dockstore.DOCUMENTATION_URL }}/getting-started/getting-started-with-docker.html">
           Create Your Tool
         </a>
       </li>
       <li>
-        <a target="_blank" href="https://docs.dockstore.org/docs/prereqs/getting-started-with-cwl/">
+        <a target="_blank" href="{{ Dockstore.DOCUMENTATION_URL }}/getting-started/getting-started-with-cwl.html">
           Describe Your Tool
         </a>
       </li>
       <li>
-        <a
-          target="_blank"
-          href="https://docs.dockstore.org/docs/publisher-tutorials/getting-started-with-dockstore/#register-your-tool-in-dockstore"
-        >
+        <a target="_blank" href="{{ Dockstore.DOCUMENTATION_URL }}/getting-started/dockstore-tools.html">
           Register Your Tool in Dockstore
         </a>
       </li>
     </ul>
     <h3>About Dockstore</h3>
     <ul>
       <li>
-        <a target="_blank" href="https://docs.dockstore.org/docs/#about-the-dockstore">
+        <a target="_blank" href="{{ Dockstore.DOCUMENTATION_URL }}/dockstore-introduction.html">
           About the Dockstore
         </a>
       </li>
       <li>
-        <a target="_blank" href="https://docs.dockstore.org/docs/#built-with-quayio-and-github">
+        <a target="_blank" href="{{ Dockstore.DOCUMENTATION_URL }}/dockstore-introduction.html#built-with-docker-and-git">
           Built with Quay.io and Github
         </a>
       </li>
       <li>
-        <a target="_blank" href="https://docs.dockstore.org/docs/#best-practices">
+        <a target="_blank" href="{{ Dockstore.DOCUMENTATION_URL }}/dockstore-introduction.html#strategies">
           Best Practices
         </a>
       </li>
       <li>
-        <a target="_blank" href="https://docs.dockstore.org/docs/#promoting-standards">
+        <a target="_blank" href="{{ Dockstore.DOCUMENTATION_URL }}/dockstore-introduction.html#promoting-standards">
           Promoting Standards
         </a>
       </li>
       <li>
-        <a target="_blank" href="https://docs.dockstore.org/docs/#future-plans">
+        <a target="_blank" href="{{ Dockstore.DOCUMENTATION_URL }}/dockstore-introduction.html#future-plans">
           Future Plans
         </a>
       </li>

src/app/sitemap/sitemap.component.ts

@@ -1,5 +1,6 @@
 import { Component, OnInit } from '@angular/core';
 import { devMode } from 'app/shared/constants';
+import { Dockstore } from '../shared/dockstore.model';
 
 @Component({
   selector: 'sitemap',
@@ -8,6 +9,7 @@ import { devMode } from 'app/shared/constants';
 })
 export class SitemapComponent implements OnInit {
   devMode = devMode;
+  Dockstore = Dockstore;
   constructor() {}
 
   ngOnInit() {}