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.

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

Jump to bottom

[☂] v1 tasks #2

Closed
22 of 23 tasks
molant opened this issue Apr 16, 2021 · 2 comments
Closed
22 of 23 tasks

[☂] v1 tasks #2

molant opened this issue Apr 16, 2021 · 2 comments

Comments

@molant
Copy link
Contributor

molant commented Apr 16, 2021 •
edited by erickzhao
Loading

Some tasks from the top of my head:

Pending:

  • Figure out i18n integration (Internationalization #64)
  • Figure out docs versioning
  • Review and update documentation style guide to match new website.
  • Create new docs landing page (@molant, @erickzhao)
  • Upstream everything we can to electron/electron
  • Update styles to match a bit more the current live site (@erickzhao)
  • Need to find a way to allow easy merges on electron/electron for the /docs folder ➡ Maybe use the CODEOWNERS plugin or similar?

Done:
molant added a commit that referenced this issue Apr 20, 2021
@molant
build: pre-build script
5e07dd7 
The pre-build scripts does the following:
1. Downloads the documentation from electron/electron and data/blog
   from electron/electronjs.org
2. Moves the files to the right folders based on the contents of
   `docs-reorg.json`
3. Add frontmatter to each file
4. Fixes internal links
5. Generates the sidebar using the folder structure

**NOTE:** The file `docs/distribution/code-signing.md` has a link split
in 2 lines that does not please docusaurus. Before running `yarn start`
that link needs to be fixed.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Ref: Solves parts of #2
molant added a commit that referenced this issue Apr 20, 2021
@molant
build: pre-build script
f323b14 
The pre-build scripts does the following:
1. Downloads the documentation from electron/electron and data/blog
   from electron/electronjs.org
2. Moves the files to the right folders based on the contents of
   `docs-reorg.json`
3. Add frontmatter to each file
4. Fixes internal links
5. Generates the sidebar using the folder structure

**NOTE:** The file `docs/distribution/code-signing.md` has a link split
in 2 lines that does not please docusaurus. Before running `yarn start`
that link needs to be fixed.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Ref: Solves parts of #2
@molant molant mentioned this issue Apr 20, 2021
Merged
molant added a commit that referenced this issue Apr 20, 2021
@molant
build: pre-build script
e16a936 
The pre-build scripts does the following:
1. Downloads the documentation from electron/electron and data/blog
   from electron/electronjs.org
2. Moves the files to the right folders based on the contents of
   `docs-reorg.json`
3. Add frontmatter to each file
4. Fixes internal links and multiline image titles
5. Generates the sidebar using the folder structure

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Ref: Solves parts of #2
molant added a commit that referenced this issue Apr 20, 2021
@molant
build: pre-build script
8dbbed4 
The pre-build scripts does the following:
1. Downloads the documentation from electron/electron and data/blog
   from electron/electronjs.org
2. Moves the files to the right folders based on the contents of
   `docs-reorg.json`
3. Add frontmatter to each file
4. Fixes internal links and multiline image titles
5. Generates the sidebar using the folder structure

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Ref: Solves parts of #2
@molant molant mentioned this issue Apr 20, 2021
Closed
molant added a commit that referenced this issue Apr 21, 2021
@molant
build: pre-build script
f9afbaf 
The pre-build scripts does the following:
1. Downloads the documentation from electron/electron and data/blog
   from electron/electronjs.org
2. Moves the files to the right folders based on the contents of
   `docs-reorg.json`
3. Add frontmatter to each file
4. Fixes internal links and multiline image titles
5. Generates the sidebar using the folder structure

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Ref: Solves parts of #2
molant added a commit that referenced this issue Apr 21, 2021
@molant
build: pre-build script
971b3fa 
The pre-build scripts does the following:
1. Downloads the documentation from electron/electron and data/blog
   from electron/electronjs.org
2. Moves the files to the right folders based on the contents of
   `docs-reorg.json`
3. Add frontmatter to each file
4. Fixes internal links and multiline image titles
5. Generates the sidebar using the folder structure

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Fix #6
Ref: Solves parts of #2
molant added a commit that referenced this issue Apr 21, 2021
@molant
build: pre-build script
972a54e 
The pre-build scripts does the following:
1. Downloads the documentation from electron/electron and data/blog
   from electron/electronjs.org
2. Moves the files to the right folders based on the contents of
   `docs-reorg.json`
3. Add frontmatter to each file
4. Fixes internal links and multiline image titles
5. Generates the sidebar using the folder structure

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Fix #6
Ref: Solves parts of #2
@erickzhao erickzhao mentioned this issue Apr 23, 2021
Merged
@erickzhao erickzhao pinned this issue Apr 23, 2021
molant added a commit that referenced this issue Apr 28, 2021
@molant
chore: add heroku config
83be811 
Add `static.json` specifying custom headers for static assets and what
folder to serve (`build`).

The Heroku application was created following
["Getting Started with Single Page Apps on Heroku"][SPA Heroku].

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Ref #2
[SPA Heroku]: https://gist.github.com/hone/24b06869b4c1eca701f9
molant added a commit that referenced this issue May 3, 2021
@molant
feat: enable docsearch
5f0894d 
Enable docsearch module with provided configuration by algolia.

Currently the search does not seem to work when `contextSearch` is
enabled. This seems to be a temporary issue per Clement's mail:

> As the DocSearch plugin is not active yet, you won't be able to use
the Docusaurus `contextualSearch` option until next crawl.

While this feature is not necessary (there are no versioned docs),
it seems like the search results page has it enabled by default
always ([1]) so might as well have it enabled everywhere to make sure it
works.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

[1]: https://github.com/temporalio/documentation/pull/357/files#r616656533
Ref: facebook/docusaurus#3805
Part of #2
@molant molant mentioned this issue May 3, 2021
Merged
molant added a commit that referenced this issue May 5, 2021
@molant
feat: enable docsearch
1191485 
Enable docsearch module with provided configuration by algolia.

Currently the search does not seem to work when `contextSearch` is
enabled. This seems to be a temporary issue per Clement's mail:

> As the DocSearch plugin is not active yet, you won't be able to use
the Docusaurus `contextualSearch` option until next crawl.

While this feature is not necessary (there are no versioned docs),
it seems like the search results page has it enabled by default
always ([1]) so might as well have it enabled everywhere to make sure it
works.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

[1]: https://github.com/temporalio/documentation/pull/357/files#r616656533
Ref: facebook/docusaurus#3805
Part of #2
Close #22
molant added a commit that referenced this issue May 10, 2021
@molant
feat: add "Examples" navigation link
adcf84d 
Add the top navigation link "Examples" and a new page that explains how
to acquire Fiddle and run the examples available in the sidebar.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Partial work on #2
@molant molant mentioned this issue May 10, 2021
Merged
molant added a commit that referenced this issue May 12, 2021
@molant
feat: add "Examples" navigation link
a122284 
Add the top navigation link "Examples" and a new page that explains how
to acquire Fiddle and run the examples available in the sidebar.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Partial work on #2
molant added a commit that referenced this issue May 12, 2021
@molant @erickzhao
feat: add "Examples" navigation link
eda594a 
Add the top navigation link "Examples" and a new page that explains how
to acquire Fiddle and run the examples available in the sidebar.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Close #26
Partial work on #2

Co-authored-by: Erick Zhao <erick@hotmail.ca>
@molant
Copy link
Contributor Author

molant commented Jul 7, 2021

@erickzhao I've reorganized a bit the top comment and added some new tasks.
What do you think of updating that list to show what we believe should be done to sunset the old docs and just have the new ones?

@erickzhao erickzhao unpinned this issue Mar 15, 2022
@erickzhao
Copy link
Member

Now that we've shipped the whole site to https://electronjs.org, I think we can close this issue. I think this is all done except for Versioned Docs!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@molant @erickzhao