Merge pull request #4572 from backstage/freben/attr

got rid of some attr and cleaned up a bit in techdocs schema

plugins/techdocs-backend/config.d.ts

@@ -13,36 +13,31 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 /**
  * TechDocs schema below is an abstract of what's used within techdocs-backend and for its visibility
  * to view the complete TechDocs schema please refer: plugins/techdocs/config.d.ts
- * */
+ */
 export interface Config {
-  /** Configuration options for the techdocs-backend plugin */
+  /**
+   * Configuration options for the techdocs-backend plugin
+   * @see http://backstage.io/docs/features/techdocs/configuration
+   */
   techdocs: {
     /**
-     * documentation building process depends on the builder attr
-     * attr: 'builder' - accepts a string value
-     * e.g. builder: 'local'
-     * alternative: 'external' etc.
-     * @see http://backstage.io/docs/features/techdocs/configuration
+     * Documentation building process depends on the builder attr
      */
     builder: 'local' | 'external';
+
     /**
-     * techdocs publisher information
+     * Techdocs publisher information
      */
     publisher: {
-      /**
-       * attr: 'type' - accepts a string value
-       * e.g. type: 'local'
-       * aleternatives: 'googleGcs' etc.
-       * @see http://backstage.io/docs/features/techdocs/configuration
-       */
       type: 'local' | 'googleGcs' | 'awsS3';
     };
+
     /**
-     * attr: 'storageUrl' - accepts a string value
-     * e.g. storageUrl: http://localhost:7000/api/techdocs/static/docs
+     * @example http://localhost:7000/api/techdocs/static/docs
      * @deprecated
      */
     storageUrl?: string;