Skip to content

Commit 47a7202

Browse files
lukegalbraithrusselllukegalbraithrussell
authored
Docs salesforce compliance (#1392)
1 parent 9785ac4 commit 47a7202

File tree

4 files changed

+114
-106
lines changed

4 files changed

+114
-106
lines changed

‎docs/README.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,9 @@ java-slack-sdk/
3030
│ ├── pages/ (stuff that isn't docs. This is empty for this repo!)
3131
│ └── theme/ (only contains the 404 page)
3232
├── version-config.yml (Where version numbers are set)
33-
├── docusaurus.config.js (main config file. also where to set navbar/footer)
33+
├── docusaurus.config.js (main config file)
34+
├── footerConfig.js (footer. go to main repo to change)
35+
├── navbarConfig.js (navbar. go to main repo to change)
3436
└── sidebar.js (manually set where the docs are in the sidebar.)
3537
```
3638

‎docs/docusaurus.config.js‎

Lines changed: 4 additions & 105 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
1-
// @ts-check
2-
// `@type` JSDoc annotations allow editor autocompletion and type checking
3-
// (when paired with `@ts-check`).
4-
// There are various equivalent ways to declare your Docusaurus config.
5-
// See: https://docusaurus.io/docs/api/docusaurus-config
6-
71
import { themes as prismThemes } from "prism-react-renderer";
2+
const footer = require('./footerConfig');
3+
const navbar = require('./navbarConfig');
84

95
/** @type {import('@docusaurus/types').Config} */
106
const config = {
@@ -42,9 +38,6 @@ const config = {
4238
theme: {
4339
customCss: "./src/css/custom.css",
4440
},
45-
gtag: {
46-
trackingID: 'G-9H1YZW28BG',
47-
},
4841
}),
4942
],
5043
],
@@ -80,102 +73,8 @@ const config = {
8073
autoCollapseCategories: true,
8174
},
8275
},
83-
navbar: {
84-
title: "Slack Developer Tools",
85-
logo: {
86-
alt: "Slack logo",
87-
src: "img/slack-logo.svg",
88-
href: "https://tools.slack.dev",
89-
target: "_self",
90-
},
91-
items: [
92-
{
93-
type: "dropdown",
94-
label: "Bolt",
95-
position: "left",
96-
items: [
97-
{
98-
label: "Java",
99-
to: "https://tools.slack.dev/java-slack-sdk/guides/bolt-basics",
100-
target: "_self",
101-
},
102-
{
103-
label: "JavaScript",
104-
to: "https://tools.slack.dev/bolt-js",
105-
target: "_self",
106-
},
107-
{
108-
label: "Python",
109-
to: "https://tools.slack.dev/bolt-python",
110-
target: "_self",
111-
},
112-
],
113-
},
114-
{
115-
type: "dropdown",
116-
label: "SDKs",
117-
position: "left",
118-
items: [
119-
{
120-
label: "Java Slack SDK",
121-
to: "https://tools.slack.dev/java-slack-sdk/",
122-
target: "_self",
123-
},
124-
{
125-
label: "Node Slack SDK",
126-
to: "https://tools.slack.dev/node-slack-sdk/",
127-
target: "_self",
128-
},
129-
{
130-
label: "Python Slack SDK",
131-
to: "https://tools.slack.dev/python-slack-sdk/",
132-
target: "_self",
133-
},
134-
{
135-
label: "Deno Slack SDK",
136-
to: "https://api.slack.com/automation/quickstart",
137-
target: "_self",
138-
},
139-
],
140-
},
141-
{
142-
type: "dropdown",
143-
label: "Community",
144-
position: "left",
145-
items: [
146-
{
147-
label: "Community tools",
148-
to: "https://tools.slack.dev/community-tools",
149-
target: "_self",
150-
},
151-
{
152-
label: "Slack Community",
153-
to: "https://slackcommunity.com/",
154-
target: "_self",
155-
},
156-
],
157-
},
158-
{
159-
to: "https://api.slack.com/docs",
160-
label: "API Docs",
161-
target: "_self",
162-
},
163-
{
164-
type: "localeDropdown",
165-
position: "right",
166-
},
167-
{
168-
"aria-label": "GitHub Repository",
169-
className: "navbar-github-link",
170-
href: "https://github.com/slackapi/java-slack-sdk",
171-
position: "right",
172-
target: "_self",
173-
},
174-
],
175-
},
176-
footer: {
177-
copyright: "<p> Made with ♡ by Slack and pals like you <p>",
178-
},
76+
navbar,
77+
footer,
17978
prism: {
18079
additionalLanguages: ['java','groovy'],
18180
// switch to alucard when available in prism?

‎docs/footerConfig.js‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
const footer = {
2+
links: [
3+
{
4+
items: [
5+
{
6+
html: `
7+
<div style="display: flex; gap: 20px; max-width: 50%">
8+
<a href="https://slack.com/terms-of-service/user">Terms of Service</a>
9+
<a href="https://slack.com/trust/privacy/privacy-policy">Privacy Information</a>
10+
</div>
11+
©2024 Slack Technologies, LLC, a Salesforce company. All rights reserved. Various trademarks held by their respective owners.
12+
`,
13+
},
14+
],
15+
},
16+
],
17+
};
18+
19+
module.exports = footer;

‎docs/navbarConfig.js‎

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
const navbar = {
2+
title: 'Slack Developer Tools',
3+
logo: {
4+
src: 'img/slack-logo.svg',
5+
},
6+
items: [
7+
{
8+
type: 'dropdown',
9+
label: 'Bolt',
10+
position: 'left',
11+
items: [
12+
{
13+
label: 'Java',
14+
to: 'https://tools.slack.dev/java-slack-sdk/guides/bolt-basics',
15+
target: '_self',
16+
},
17+
{
18+
label: 'JavaScript',
19+
to: 'https://tools.slack.dev/bolt-js',
20+
target: '_self',
21+
},
22+
{
23+
label: 'Python',
24+
to: 'https://tools.slack.dev/bolt-python',
25+
target: '_self',
26+
},
27+
],
28+
},
29+
{
30+
type: 'dropdown',
31+
label: 'SDKs',
32+
position: 'left',
33+
items: [
34+
{
35+
label: 'Java Slack SDK',
36+
to: 'https://tools.slack.dev/java-slack-sdk/',
37+
target: '_self',
38+
},
39+
{
40+
label: 'Node Slack SDK',
41+
to: 'https://tools.slack.dev/node-slack-sdk/',
42+
target: '_self',
43+
},
44+
{
45+
label: 'Python Slack SDK',
46+
to: 'https://tools.slack.dev/python-slack-sdk/',
47+
target: '_self',
48+
},
49+
{
50+
label: 'Deno Slack SDK',
51+
to: 'https://api.slack.com/automation/quickstart',
52+
target: '_self',
53+
},
54+
],
55+
},
56+
{
57+
type: 'dropdown',
58+
label: 'Community',
59+
position: 'left',
60+
items: [
61+
{
62+
label: 'Community tools',
63+
to: 'https://tools.slack.dev/community-tools',
64+
target: '_self',
65+
},
66+
{
67+
label: 'Slack Community',
68+
to: 'https://slackcommunity.com/',
69+
target: '_self',
70+
},
71+
],
72+
},
73+
{
74+
to: 'https://api.slack.com/docs',
75+
label: 'API Docs',
76+
target: '_self',
77+
},
78+
{
79+
'aria-label': 'GitHub Repository',
80+
className: 'navbar-github-link',
81+
href: 'https://github.com/slackapi',
82+
position: 'right',
83+
target: '_self',
84+
},
85+
],
86+
};
87+
88+
module.exports = navbar;

0 commit comments

Comments
 (0)