Skip to content

Acq 2304 improve swiftype #259

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

Merged
merged 3 commits into from
Nov 19, 2019
Merged

Acq 2304 improve swiftype #259

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2087c4d
update swiftype meta tags to accept description and product info
Nov 19, 2019
1788953
remove update description function and move logic to liquid template
Nov 19, 2019
c12a961
Merge branch 'master' into ACQ-2304-improve-swiftype
XavierAgostini Nov 19, 2019
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
29 changes: 0 additions & 29 deletions scripts/catalog.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,33 +113,6 @@ const doesCatalogItemExist = (item) => {
}
}

/**
*
* Update catalog item frontmatter description
*/
function updateCatalogItemDescription (description, display_name, url) {
let updatedDescription = description.length ? description.trim() : `The technical documentation for ${display_name}`
const itemPath = path.resolve(__dirname, `../src/${url}/index.md`)
const originalText = fs.readFileSync(itemPath, 'utf8')
// Get index of closing '---'
const frontMatterIndex = originalText.substring(4).indexOf('---') + 3
const frontMatter = originalText.substring(0, frontMatterIndex)
let newText = ''
if (!frontMatter.match(/^description:(.)*$/gm)) {
updatedDescription = `\ndescription: "${updatedDescription}"`
newText = frontMatter + `${updatedDescription}` + originalText.substring(frontMatterIndex)
} else {
newText = originalText.replace(/^description:.*$/gm, `description: "${updatedDescription}"`)
}

try {
fs.writeFileSync(itemPath, newText)
} catch (e) {
console.error(`Couldn't write to file: ${uritemPathl}`)
console.error(e)
}
}

const updateSources = async () => {
let sources = []
let sourcesUpdated = []
Expand Down Expand Up @@ -194,7 +167,6 @@ const updateSources = async () => {
}
sourcesUpdated.push(updatedSource)
doesCatalogItemExist(updatedSource)
updateCatalogItemDescription(source.description, source.display_name, url)
// add unique source categories to set
source.categories.reduce((s, e) => s.add(e), categories);
})
Expand Down Expand Up @@ -268,7 +240,6 @@ const updateDestinations = async () => {
}
destinationsUpdated.push(updatedDestination)
doesCatalogItemExist(updatedDestination)
updateCatalogItemDescription(destination.description, destination.display_name, url)
// add unique destination categories to set
tempCategories.reduce((s, e) => s.add(e), categories);
})
Expand Down
34 changes: 23 additions & 11 deletions src/_layouts/default.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,21 @@
{% capture basehref %}{{ page.url }}{% endcapture %}
{% assign sectionNames = basehref | split: "/" %}

{% assign sectionName = sectionNames[1] | capitalize %}
{% assign currentSlug = page.url | split: "/" | last %}
{% assign priority = 2 %}
{% if page.integration_type == "destination" %}
{% assign currentIntegration = site.data.catalog.destinations.items | where: "slug", currentSlug | first %}
{% assign description = currentIntegration.description %}
{% assign priority = 4 %}
{% elsif page.integration_type == "source" %}
{% assign currentIntegration = site.data.catalog.sources.items | where: "slug", currentSlug | first %}
{% assign description = currentIntegration.description %}
{% assign priority = 4 %}
{% else %}
{% assign description = "The technical documentation for Segment." %}
{% endif %}

<html lang="{{ page.lang | default: site.lang | default: "en" }}">
<head>
<base href="/docsv2{{ basehref }}" />
Expand All @@ -13,22 +29,18 @@
<meta name="twitter:site" content="@segment" />
<meta name="twitter:card" content="summary_large_image" />

{% if page.description %}
<meta name="description" content="{{page.description}}">
<meta property="og:description" content="{{page.description}}" />
{% else %}
<meta name="description" content="The technical documentation for Segment.">
<meta property="og:description" content="The technical documentation for Segment.">
{% endif %}

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

{% if page.hidden %}
<meta name="robots" content="noindex" />
{% else %}
<meta class="swiftype" name="section" data-type="enum" content="{{ sectionNames[1] }}" />
<meta class="swiftype" name="info" data-type="enum" content="{{page.description}}" />
<meta class="swiftype" name="description" data-type="enum" content="{{page.description}}" />
<meta class="swiftype" name="section" data-type="enum" content="{{ sectionName }}" />
<meta class="swiftype" name="info" data-type="enum" content="{{description}}" />
<meta class="swiftype" name="description" data-type="enum" content="{{description}}" />
<meta class="swiftype" name="title" data-type="string" content="{{page.title}}" />
<meta class="swiftype" name="priority" data-type="integer" content="2" />
<meta class="swiftype" name="priority" data-type="integer" content="{{priority}}" />
{% endif %}
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css"/>

Expand Down