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

feat: setup new docs #7386

Merged
merged 12 commits into from
Dec 6, 2023
Merged

Conversation

tkajtoch
Copy link
Member

Summary

This PR configures the docusaurus and adds sample documentation files. Note that it targets the new feat/new-docs feature branch and is meant to be used primarily for testing.

QA

  1. Checkout this branch locally and cd into the website directory
  2. Run yarn and yarn start
  3. Confirm the dev server is loading and http://localhost:3000/docs/guidelines/getting-started renders the sample documentation page

@tkajtoch tkajtoch self-assigned this Nov 23, 2023
@tkajtoch tkajtoch requested a review from a team as a code owner November 23, 2023 13:48
website/static/.nojekyll Outdated Show resolved Hide resolved
darkTheme: prismThemes.dracula,
additionalLanguages: ['scss'],
},
} satisfies Preset.ThemeConfig,
Copy link
Contributor

Choose a reason for hiding this comment

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

{
href: 'https://github.com/elastic/eui',
label: 'GitHub',
position: 'right',
Copy link
Contributor

Choose a reason for hiding this comment

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

Just curious, could we use an icon for this instead of text?

Copy link
Member Author

Choose a reason for hiding this comment

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

The classic docusaurus theme doesn't support it by default but it's easy to add it manually if we wanted to!

footer: {
style: 'light',
links: [],
copyright: `EUI is dual-licensed under <a href="https://github.com/elastic/eui/blob/main/licenses/ELASTIC-LICENSE-2.0.md">Elastic License 2.0</a> and <a href="https://github.com/elastic/eui/blob/main/licenses/SSPL-LICENSE.md">Server Side Public License, v 1</a> | Crafted with ❤️ by <a href="https://elastic.co">Elastic</a>`,
Copy link
Contributor

Choose a reason for hiding this comment

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

ARE WE CRAFTED WITH LOVE OR WITH SPITE

Copy link
Contributor

Choose a reason for hiding this comment

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

note to ourselves: reorder side nav at some point; this intro was confusing not actually an intro / at the top of the nav

website/README.md Outdated Show resolved Hide resolved
@kibanamachine
Copy link

Preview staging links for this PR:

@elasticmachine
Copy link
Collaborator

💚 Build Succeeded

History

cc @tkajtoch

@tkajtoch tkajtoch requested a review from a team December 6, 2023 20:31
Copy link
Contributor

@1Copenut 1Copenut left a comment

Choose a reason for hiding this comment

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

🚀 LGTM! I ran through your QA steps and it worked perfectly. Went from cold start to viewing docs in under a minute.

@tkajtoch tkajtoch merged commit aa023ee into elastic:feat/new-docs Dec 6, 2023
tkajtoch added a commit that referenced this pull request Dec 7, 2023
tkajtoch added a commit that referenced this pull request Dec 13, 2023
tkajtoch added a commit to tkajtoch/eui that referenced this pull request Jan 22, 2024
tkajtoch added a commit that referenced this pull request Jan 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants