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.

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

Issues list clean up #156

Open
wants to merge 22 commits into
base: production
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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: 1 addition & 3 deletions .npmrc
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@

legacy-peer-deps=true

legacy-peer-deps=true
2 changes: 1 addition & 1 deletion content/api/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: SaaSquatch REST API
title: REST API
highlights: Our REST API lets you build your own custom logic on top of your referral program. The [API reference](/api/methods) includes details about using all the methods of the SaaSquatch REST API.
slug: api
sectionType: apiReference
Expand Down
2 changes: 1 addition & 1 deletion content/guides/conversion.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ template: hasTableOfContents.html
date: '2019-11-18'
---

For a full explanation of the difference between identification, attribution and conversion, check out [The Basics Success Center Article](/intro) and the [Success Center Guide on Conversion](/topics/conversion)
For a full explanation of the difference between identification, attribution and conversion, check out [The Basics Success Center Article](/success/intro) and the [Success Center Guide on Conversion](/topics/conversion)

### Squatch.js

Expand Down
2 changes: 1 addition & 1 deletion content/guides/dollar-credit.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Dollar Credit Integration Guide
title: Dollar Credit
highlights: Follow this guide to setup a "Give $20, Get $20 Referral Program" using the SaaSquatch REST API and Squatch.js
slug: guides/dollar-credit
sectionType: guide
Expand Down
2 changes: 1 addition & 1 deletion content/guides/pctDiscountGuide.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Percent Discount Integration Guide"
title: "Percent Discount"
highlights: "Give your users 10% for a year for referring a friend. Follow this guide to setup a 'Give 10%, Get 10% Referral Program' using the SaaSquatch REST API and Squatch.js"
slug: guides/percent-discount
sectionType: guide
Expand Down
2 changes: 1 addition & 1 deletion content/guides/pointsGuide.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Points Integration Guide
title: Point Reward
highlights: Follow this guide to setup a "Give 50, Get 50 Points Referral Program" using the SaaSquatch REST API and Squatch.js
slug: guides/point-reward
sectionType: guide
Expand Down
1 change: 1 addition & 0 deletions content/guides/zuora.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@ highlights: In order to respect Zuora's privacy policies Zuora integration docum
slug: developer/zuora
sectionType: guide
template: article.html
robots : noindex, nofollow
date: '2019-11-18'
---
2 changes: 1 addition & 1 deletion content/mobile/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Mobile
title: iOS & Android integration
highlights: SaaSquatch helps you grow your mobile app with a referral program. We provide mobile widgets to engage your users, attribution to track referrals, and analytics to measure the success of your program.
slug: mobile
sectionType: mobile
Expand Down
1 change: 1 addition & 0 deletions content/theming/assets.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
slug: themes/assets
sectionType: themes
template: article.html
robots : noindex, nofollow
date: '2019-11-18'
---

Expand Down
2 changes: 1 addition & 1 deletion content/theming/index.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Themes
title: Program Themes
highlights: |
Referral SaaSquatch themes let your referral program be customized to pixel-perfect brand constraints.
**Standard Themes** make launching a referral program easy with pre-packaged widgets and emails, and **Custom Themes** allow for total customization to meet your brand and program needs.
Expand Down
1 change: 1 addition & 0 deletions content/theming/standard.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
slug: themes/standard
sectionType: themes
template: article.html
robots : noindex, nofollow
date: '2019-11-18'
---

Expand Down
1 change: 1 addition & 0 deletions content/theming/templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ highlights: Referral SaaSquatch templates use **Handlebars**. Handlebars let you
slug: themes/templates
sectionType: themes
template: article.html
robots : noindex, nofollow
date: '2019-11-18'
---

Expand Down
1 change: 1 addition & 0 deletions content/theming/widgetjs.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ highlights: Publicly available widget JS API at ```window.widget.rpc = widget.rp
slug: themes/widgetjs
sectionType: themes
template: article.html
robots : noindex, nofollows
date: '2019-11-18'
---

Expand Down
36 changes: 25 additions & 11 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@
"react-dom": "^16.9.0",
"react-hotkeys-hook": "^2.4.0",
"react-mailchimp-subscribe": "^2.1.0",
"react-meta-tags": "^1.0.1",
"react-static": "^7.2.0",
"react-static-plugin-reach-router": "^7.2.0",
"react-static-plugin-sitemap": "^7.2.0",
Expand Down
1 change: 1 addition & 0 deletions public/mobile/android/docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
<head>
<!-- Generated by javadoc (1.8.0_73) on Fri Apr 29 12:21:19 PDT 2016 -->
<title>Generated Documentation (Untitled)</title>
<meta name="robots" content="noindex, nofollow" />
<script type="text/javascript">
targetPage = "" + window.location.search;
if (targetPage != "" && targetPage != "undefined")
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion src/assets/stylesheets/_basics.less
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ h5 {
}

a .link {
background-color: #fff;
background-color: #fff;
}

a:link {
Expand Down
48 changes: 23 additions & 25 deletions src/components/Meta.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import React from "react";
import marked from "marked";

// import ogImage from "../assets/images/opengraph-center-crop-helpcenter.png";
const ogImage = require("../assets/images/opengraph-center-crop-helpcenter.png");
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets fix this before sending it out

import { Entry } from "./TocFrame";
import { Head } from "react-static";

Expand All @@ -23,11 +24,17 @@ export default function render(

let title:string;
if(props.title){
title = props.title + " | SaaSquatch " + (props.categoryName || "Documentation");
title = props.title + " | SaaSquatch " + (props.categoryName || "Docs");
}else{
title = "SaaSquatch Help Center";
title = "SaaSquatch Docs";
}

let ogImageURL:string;
if(props?.fields?.ogFeaturedImage != null && Object.keys(props?.fields?.ogFeaturedImage).length > 0){
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There must be a cleaner way to do this

ogImageURL = props?.fields?.ogFeaturedImage[0]?.fields?.file?.url;
}



const plainHighlights = striptags(markdown(props.highlights));
return (
<Head>
Expand All @@ -37,29 +44,20 @@ export default function render(
"docs sectionType-" + props.sectionType + " " + props.category
}
/>
{/* SEO content */}
<meta name="description" content={props.fields?.seoDescription || props?.highlights}/>

<meta property="og:image" content={ogImageURL || ogImage} />
<meta name="twitter:image" content={ogImageURL || ogImage} />

<meta name="robots" content={props.fields?.robotsTag || props?.robots} />
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Noting that the contentful default here is "FOLLOW", lets make sure that is handled appropriately

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also need to make sure this is handled well for the content within the code that does not have any robots information

<link rel="canonical" href={props.fields?.canonicalUrl}/>



<meta property="og:title" content={title} />
<meta
className="swiftype"
name="title"
data-type="string"
content={props.title}
/>
<meta
className="swiftype"
name="body"
data-type="text"
content={props.fields?.seoDescription || props.highlights}
/>
<meta name="description" content={plainHighlights} />

<meta property="og:description" content={plainHighlights} />

<meta
className="swiftype"
name="type"
data-type="enum"
content={props.sectionType}
/>

<meta
name="docsSectionType"
data-type="string"
Expand Down
16 changes: 15 additions & 1 deletion src/components/TocFrame.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import TOC from "./TOC";
*/
export type Entry = {
title: string;
robots?: string;
Copy link
Contributor

@DerekSiemens DerekSiemens Oct 14, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if we can change the usage of just the plain robots in the docs within the code so we don't need two types

contents?: string;
highlights?: string;
hero?: boolean;
Expand All @@ -22,7 +23,20 @@ export type Entry = {
category?: string;
categoryName?: string;
sectionType?: string;
fields?: { seoDescription?: string };
fields?: {
seoDescription?: string,
ogFeaturedImage?: {
fields?:{
file?:{
url?: string;
}
}
}
robotsTag?: string,
canonicalUrl?: string;


};
};


Expand Down
Loading