Skip to content

Commit

Permalink
Docs: salesforce compliance adjustments (#1581)
Browse files Browse the repository at this point in the history
  • Loading branch information
@lukegalbraithrussell
lukegalbraithrussell authored Oct 31, 2024
1 parent 1d0fda6 commit f8492d4
Show file tree
Hide file tree
Showing 7 changed files with 248 additions and 251 deletions.
4 changes: 3 additions & 1 deletion docs/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,9 @@ docs/
│ └── oslo.svg
├── src/
│ └── 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 content docs are in the sidebar.)
```

Expand Down
246 changes: 72 additions & 174 deletions docs/docusaurus.config.js
View file
Original file line number Diff line number Diff line change
@@ -1,186 +1,84 @@
// @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";
const footer = require("./footerConfig");
const navbar = require("./navbarConfig");

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

url: "https://tools.slack.dev",
baseUrl: "/python-slack-sdk/",
organizationName: "slackapi",
projectName: "python-slack-sdk",
title: "Python Slack SDK",
tagline: "Official frameworks, libraries, and SDKs for Slack developers",
favicon: "img/favicon.ico",
url: "https://tools.slack.dev",
baseUrl: "/python-slack-sdk/",
organizationName: "slackapi",
projectName: "python-slack-sdk",

onBrokenLinks: "warn",
onBrokenAnchors: "warn",
onBrokenMarkdownLinks: "warn",
onBrokenLinks: "warn",
onBrokenAnchors: "warn",
onBrokenMarkdownLinks: "warn",

i18n: {
defaultLocale: "en",
locales: ["en"],
},
i18n: {
defaultLocale: "en",
locales: ["en"],
},

presets: [
[
"classic",
/** @type {import('@docusaurus/preset-classic').Options} */
({
docs: {
path: "content",
breadcrumbs: false,
routeBasePath: "/", // Serve the docs at the site's root
sidebarPath: "./sidebars.js",
editUrl:
"https://github.com/slackapi/python-slack-sdk/tree/main/docs",
},
blog: false,
theme: {
customCss: "./src/css/custom.css",
},
gtag: {
trackingID: "G-9H1YZW28BG",
},
}),
],
],
presets: [
[
"classic",
/** @type {import('@docusaurus/preset-classic').Options} */
({
docs: {
path: "content",
breadcrumbs: false,
routeBasePath: "/", // Serve the docs at the site's root
sidebarPath: "./sidebars.js",
editUrl:
"https://github.com/slackapi/python-slack-sdk/tree/main/docs",
},
blog: false,
theme: {
customCss: "./src/css/custom.css",
},
}),
],
],

plugins: [
"docusaurus-theme-github-codeblock",
[
"@docusaurus/plugin-client-redirects",
{
redirects: [],
},
],
],
plugins: [
"docusaurus-theme-github-codeblock",
[
"@docusaurus/plugin-client-redirects",
{
redirects: [],
},
],
],

themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
colorMode: {
respectPrefersColorScheme: true,
},
docs: {
sidebar: {
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/python-slack-sdk",
position: "right",
target: "_self",
},
],
},
footer: {
copyright: `<p> Made with ♡ by Slack and pals like you <p>`,
},
prism: {
// switch to alucard when available in prism?
theme: prismThemes.github,
darkTheme: prismThemes.dracula,
},
codeblock: {
showGithubLink: true,
githubLinkLabel: "View on GitHub",
},
// announcementBar: {
// id: `announcementBar`,
// content: `🎉️ <b><a target="_blank" href="https://api.slack.com/">Version 2.26.0</a> of the developer tools for the Slack automations platform is here!</b> 🎉️ `,
// },
}),
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
colorMode: {
respectPrefersColorScheme: true,
},
docs: {
sidebar: {
autoCollapseCategories: true,
},
},
navbar,
footer,
prism: {
// switch to alucard when available in prism?
theme: prismThemes.github,
darkTheme: prismThemes.dracula,
},
codeblock: {
showGithubLink: true,
githubLinkLabel: "View on GitHub",
},
// announcementBar: {
// id: `announcementBar`,
// content: `🎉️ <b><a target="_blank" href="https://api.slack.com/">Version 2.26.0</a> of developer tools for the Slack automations platform is here!</b> 🎉️ `,
// },
}),
};

export default config;
19 changes: 19 additions & 0 deletions docs/footerConfig.js
View file
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
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;
Loading

0 comments on commit f8492d4

Please sign in to comment.