feat: add official docs link
This commit is contained in:
@@ -1,56 +0,0 @@
|
||||
# Docs for the Azure Web Apps Deploy action: https://github.com/Azure/webapps-deploy
|
||||
# More GitHub Actions for Azure: https://github.com/Azure/actions
|
||||
|
||||
name: Build and deploy Node.js app to Azure Web App - onspringapidocs
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
|
||||
- name: Set up Node.js version
|
||||
uses: actions/setup-node@v1
|
||||
with:
|
||||
node-version: '18.x'
|
||||
|
||||
- name: npm install, build, and test
|
||||
run: |
|
||||
npm install
|
||||
npm run build --if-present
|
||||
npm run test --if-present
|
||||
|
||||
- name: Upload artifact for deployment job
|
||||
uses: actions/upload-artifact@v2
|
||||
with:
|
||||
name: node-app
|
||||
path: .
|
||||
|
||||
deploy:
|
||||
runs-on: ubuntu-latest
|
||||
needs: build
|
||||
environment:
|
||||
name: 'Production'
|
||||
url: ${{ steps.deploy-to-webapp.outputs.webapp-url }}
|
||||
|
||||
steps:
|
||||
- name: Download artifact from build job
|
||||
uses: actions/download-artifact@v2
|
||||
with:
|
||||
name: node-app
|
||||
|
||||
- name: 'Deploy to Azure Web App'
|
||||
id: deploy-to-webapp
|
||||
uses: azure/webapps-deploy@v2
|
||||
with:
|
||||
app-name: 'onspringapidocs'
|
||||
slot-name: 'Production'
|
||||
publish-profile: ${{ secrets.AZUREAPPSERVICE_PUBLISHPROFILE_8C6CD43B120C43948EB494F70945D231 }}
|
||||
package: .
|
||||
@@ -111,6 +111,10 @@
|
||||
border-radius: 0.25rem;
|
||||
}
|
||||
|
||||
.docsNote {
|
||||
padding-left: 1rem;
|
||||
}
|
||||
|
||||
@media screen and (max-width: 1000px) {
|
||||
.nav {
|
||||
align-items: flex-start;
|
||||
|
||||
@@ -190,6 +190,15 @@ export default function NavBar({
|
||||
<li className={styles.navItem}>
|
||||
<VersionsDropdown version={version.version} />
|
||||
</li>
|
||||
<li className={styles.navItem}>
|
||||
<Link
|
||||
href={version.officialDocs}
|
||||
className={styles.navLink}
|
||||
target="_blank"
|
||||
>
|
||||
Official Docs
|
||||
</Link>
|
||||
</li>
|
||||
<li className={styles.navItem}>
|
||||
{version.hasSwagger ? (
|
||||
<Link
|
||||
|
||||
@@ -2,6 +2,7 @@ import { ReactNode } from 'react';
|
||||
|
||||
export type DocsStructure = {
|
||||
version: string;
|
||||
officialDocs: string;
|
||||
hasSwagger: boolean;
|
||||
docs: Doc[];
|
||||
};
|
||||
|
||||
@@ -2,6 +2,8 @@ import { DocsStructure } from '@/app/types/types';
|
||||
|
||||
export const versionOne: DocsStructure = {
|
||||
version: 'version_001',
|
||||
officialDocs:
|
||||
'https://software.onspring.com/hubfs/Training/Admin%20Guide%20-%20v1%20API.pdf',
|
||||
hasSwagger: false,
|
||||
docs: [
|
||||
{
|
||||
|
||||
@@ -2,6 +2,8 @@ import { DocsStructure } from '@/app/types/types';
|
||||
|
||||
export const versionTwo: DocsStructure = {
|
||||
version: 'version_002',
|
||||
officialDocs:
|
||||
'https://software.onspring.com/hubfs/Training/Admin%20Guide%20-%20v2%20API.pdf',
|
||||
hasSwagger: true,
|
||||
docs: [
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user