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

Add localized section names to navigation #70

Merged
merged 6 commits into from
Dec 17, 2024
Merged
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
60 changes: 60 additions & 0 deletions generateNavigation.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ const fs = require("fs");
const path = require("path");
require("dotenv").config();

console.log('Generating navigation...')

const client = contentful.createClient({
accessToken: process.env.CONTENTFUL_ACCESS_TOKEN,
});
Expand All @@ -22,32 +24,68 @@ const errorDocs = {
const navigation = { navbar: [
{
documentation: 'Start here',
name: {
en: 'Start here',
es: 'Comece aqui',
pt: 'Comece aqui'
},
slugPrefix: 'docs/tracks',
categories: []
},
{
documentation: 'Tutorials',
name: {
en: 'Tutorials',
es: 'Tutoriales',
pt: 'Tutoriais'
},
slugPrefix: 'docs/tutorial',
categories: []
},
{
documentation: 'News',
name: {
en: 'News',
es: 'Anuncios',
pt: 'Comunicados'
},
slugPrefix: 'announcements',
categories: []
},
{
documentation: 'FAQs',
name: {
en: 'Frequently asked questions',
es: 'Preguntas frecuentes',
pt: 'Perguntas frequentes'
},
slugPrefix: 'faq',
categories: []
},
{
documentation: 'Known Issues',
name: {
en: 'Known issues',
es: 'Problemas Conocidos',
pt: 'Problemas conhecidos'
},
slugPrefix: 'known-issues',
categories: []
},
{
documentation: 'Troubleshooting',
name: {
en: 'Troubleshooting',
es: 'Troubleshooting',
pt: 'Troubleshooting'
},
slugPrefix: 'troubleshooting',
categories: []
}
] };

function getTutorialEndpoints(endpointIds) {
console.log('Getting tutorial endpoints...')
const children = [];
for (let i = 0; i < endpointIds.length; i++) {
const id = endpointIds[i].sys.id;
Expand All @@ -59,6 +97,7 @@ function getTutorialEndpoints(endpointIds) {
}

function getTutorialSubcategories(subcategoriesIds) {
console.log('Getting tutorial subcategories...')
const children = [];
for (let i = 0; i < subcategoriesIds.length; i++) {
const id = subcategoriesIds[i].sys.id;
Expand All @@ -77,6 +116,7 @@ function getTutorialSubcategories(subcategoriesIds) {
}

function getTutorialCategories() {
console.log('Getting tutorial categories...')
const categories = [];
for (let i = 0; i < tutorialCategories.length; i++) {
const { subcategories, ...obj } = tutorialCategories[i];
Expand All @@ -92,6 +132,7 @@ function getTutorialCategories() {
}

function getTrackArticles(steps) {
console.log('Getting track articles...')
const children = [];
for (let i = 0; i < steps.length; i++) {
const id = steps[i].sys.id;
Expand All @@ -104,6 +145,7 @@ function getTrackArticles(steps) {
}

function getTracks(trackIds) {
console.log('Getting tracks...')
const children = [];
for (let i = 0; i < trackIds.length; i++) {
const id = trackIds[i].sys.id;
Expand All @@ -121,6 +163,7 @@ function getTracks(trackIds) {
}

function getTrackTopics() {
console.log('Getting track topics...')
const categories = [];
for (let i = 0; i < trackTopics.length; i++) {
const { trackChildren, ...obj } = trackTopics[i];
Expand All @@ -135,6 +178,7 @@ function getTrackTopics() {
}

function getNews() {
console.log('Getting news...')

const months = [
{ en: 'January', es: 'Enero', pt: 'Janeiro' },
Expand Down Expand Up @@ -260,6 +304,7 @@ function getNews() {
}

function getFaq() {
console.log('Getting FAQs...')
const enDir = 'docs/en/faq';
const ptDir = 'docs/pt/faq';
const esDir = 'docs/es/faq';
Expand Down Expand Up @@ -334,6 +379,7 @@ function getFaq() {
}

function getKnownIssues() {
console.log('Getting Known Issues...')
const enDir = 'docs/en/known-issues';
const ptDir = 'docs/pt/known-issues';
const esDir = 'docs/es/known-issues';
Expand Down Expand Up @@ -407,7 +453,19 @@ function getKnownIssues() {
return knownIssuesCategories;
}

function getTroubleshooting() {
const tutorialsContent = navigation.navbar[1].categories
const troubleshootingIndex = tutorialsContent.findIndex(category => category.name.en === 'Troubleshooting')
const troubleshootingContent = tutorialsContent[troubleshootingIndex].children

// Remove the troubleshooting category from the tutorials categories array
navigation.navbar[1].categories.splice(troubleshootingIndex, 1)

return troubleshootingContent
}

async function getEntries() {
console.log('Getting entries...')
try {
const space = await client.getSpace("alneenqid6w5");
const environment = await space.getEnvironment("master");
Expand Down Expand Up @@ -503,6 +561,8 @@ async function getEntries() {

navigation.navbar[4].categories = getKnownIssues();

navigation.navbar[5].categories = getTroubleshooting();

fs.writeFile('errorDocs.json', JSON.stringify(errorDocs), (err) => console.error(err));
fs.writeFile('navigation.json', JSON.stringify(navigation), (err) => console.error(err));
} catch (error) {
Expand Down
Loading