Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: salesforce compliance adjustment #1190

Merged
merged 2 commits into from
Oct 31, 2024
Merged

Docs: salesforce compliance adjustment #1190

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ffdc071
docs: salesforce compliance adjustment
lukegalbraithrussell Oct 31, 2024
c1c03a3
docs: update readme
lukegalbraithrussell Oct 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,9 @@ website/
├── src/
│ ├── pages/ (stuff that isn't docs. This is empty for this repo!)
│ └── theme/ (only contains the 404 page)
├── docusaurus.config.js (main config file. also where to set navbar/footer)
├── docusaurus.config.js (main config file)
├── footerConfig.js (footer. go to main repo to change)
├── navbarConfig.js (navbar. go to main repo to change)
└── sidebar.js (manually set where the docs are in the sidebar.)
```

Expand Down
112 changes: 5 additions & 107 deletions docs/docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,12 @@
// @ts-check
// `@type` JSDoc annotations allow editor autocompletion and type checking
// (when paired with `@ts-check`).
// There are various equivalent ways to declare your Docusaurus config.
// See: https://docusaurus.io/docs/api/docusaurus-config

import { themes as prismThemes } from "prism-react-renderer";
import { themes as prismThemes } from 'prism-react-renderer';
const footer = require('./footerConfig');
const navbar = require('./navbarConfig');

/** @type {import('@docusaurus/types').Config} */
const config = {
title: "Bolt for Python",
tagline: "Official frameworks, libraries, and SDKs for Slack developers",
favicon: "img/favicon.ico",

url: "https://tools.slack.dev",
baseUrl: "/bolt-python/",
organizationName: "slackapi",
Expand Down Expand Up @@ -42,9 +37,6 @@ const config = {
theme: {
customCss: "./src/css/custom.css",
},
gtag: {
trackingID: 'G-9H1YZW28BG',
},
}),
],
],
Expand Down Expand Up @@ -79,102 +71,8 @@ const config = {
autoCollapseCategories: true,
},
},
navbar: {
title: "Slack Developer Tools",
logo: {
alt: "Slack logo",
src: "img/slack-logo.svg",
href: "https://tools.slack.dev",
target: "_self",
},
items: [
{
type: "dropdown",
label: "Bolt",
position: "left",
items: [
{
label: "Java",
to: "https://tools.slack.dev/java-slack-sdk/guides/bolt-basics",
target: "_self",
},
{
label: "JavaScript",
to: "https://tools.slack.dev/bolt-js",
target: "_self",
},
{
label: "Python",
to: "https://tools.slack.dev/bolt-python",
target: "_self",
},
],
},
{
type: "dropdown",
label: "SDKs",
position: "left",
items: [
{
label: "Java Slack SDK",
to: "https://tools.slack.dev/java-slack-sdk/",
target: "_self",
},
{
label: "Node Slack SDK",
to: "https://tools.slack.dev/node-slack-sdk/",
target: "_self",
},
{
label: "Python Slack SDK",
to: "https://tools.slack.dev/python-slack-sdk/",
target: "_self",
},
{
label: "Deno Slack SDK",
to: "https://api.slack.com/automation/quickstart",
target: "_self",
},
],
},
{
type: "dropdown",
label: "Community",
position: "left",
items: [
{
label: "Community tools",
to: "https://tools.slack.dev/community-tools",
target: "_self",
},
{
label: "Slack Community",
to: "https://slackcommunity.com/",
target: "_self",
},
],
},
{
to: "https://api.slack.com/docs",
label: "API Docs",
target: "_self",
},
{
type: "localeDropdown",
position: "right",
},
{
"aria-label": "GitHub Repository",
className: "navbar-github-link",
href: "https://github.com/slackapi/bolt-python",
position: "right",
target: "_self",
},
],
},
footer: {
copyright: `<p> Made with ♡ by Slack and pals like you <p>`,
},
navbar,
footer,
prism: {
// switch to alucard when available in prism?
theme: prismThemes.github,
Expand Down
19 changes: 19 additions & 0 deletions docs/footerConfig.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
const footer = {
links: [
{
items: [
{
html: `
<div style="display: flex; gap: 20px; max-width: 50%">
<a href="https://slack.com/terms-of-service/user">Terms of Service</a>
<a href="https://slack.com/trust/privacy/privacy-policy">Privacy Information</a>
</div>
©2024 Slack Technologies, LLC, a Salesforce company. All rights reserved. Various trademarks held by their respective owners.
`,
},
],
},
],
};

module.exports = footer;
88 changes: 88 additions & 0 deletions docs/navbarConfig.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
const navbar = {
title: 'Slack Developer Tools',
logo: {
src: 'img/slack-logo.svg',
},
items: [
{
type: 'dropdown',
label: 'Bolt',
position: 'left',
items: [
{
label: 'Java',
to: 'https://tools.slack.dev/java-slack-sdk/guides/bolt-basics',
target: '_self',
},
{
label: 'JavaScript',
to: 'https://tools.slack.dev/bolt-js',
target: '_self',
},
{
label: 'Python',
to: 'https://tools.slack.dev/bolt-python',
target: '_self',
},
],
},
{
type: 'dropdown',
label: 'SDKs',
position: 'left',
items: [
{
label: 'Java Slack SDK',
to: 'https://tools.slack.dev/java-slack-sdk/',
target: '_self',
},
{
label: 'Node Slack SDK',
to: 'https://tools.slack.dev/node-slack-sdk/',
target: '_self',
},
{
label: 'Python Slack SDK',
to: 'https://tools.slack.dev/python-slack-sdk/',
target: '_self',
},
{
label: 'Deno Slack SDK',
to: 'https://api.slack.com/automation/quickstart',
target: '_self',
},
],
},
{
type: 'dropdown',
label: 'Community',
position: 'left',
items: [
{
label: 'Community tools',
to: 'https://tools.slack.dev/community-tools',
target: '_self',
},
{
label: 'Slack Community',
to: 'https://slackcommunity.com/',
target: '_self',
},
],
},
{
to: 'https://api.slack.com/docs',
label: 'API Docs',
target: '_self',
},
{
'aria-label': 'GitHub Repository',
className: 'navbar-github-link',
href: 'https://github.com/slackapi',
position: 'right',
target: '_self',
},
],
};

module.exports = navbar;