I tried this

Go directly to https://docs.winglang.io/concepts/simulator#using-the-simulator-api-in-wing

Expected

I expected to jump directly to the right location of the "using-the-simulator-api-in-wing" section in the file

Instead, this happened

I landed in the top of the doc

Component

Documentation

Environment

- Wing Version: NA
- OS: NA
- Node version:NA

Anything else?

It used to work, I found a vercel site that has this working https://website-5wr130rjs-monada.vercel.app/concepts/simulator#using-the-simulator-api-in-wing

slack discussion: https://winglang.slack.com/archives/C048QCN2XLJ/p1669154174786549

Need to switch to payed program

My personal github token from November 2022 expired, so I went through the steps to generate a new one. The docs now say only read:packages is required here. However, that results in a forbidden error during npm login. If I add repo permissions like the previous instructions, I can login. What are the actual minimum permissions needed?

With read:packages and no repo permissions:

npm login --scope=@winglang --registry=https://npm.pkg.github.com
npm WARN adduser `adduser` will be split into `login` and `register` in a future version. `adduser` will become an alias of `register`. `login` (currently an alias) will become its own command.
npm notice Log in on https://npm.pkg.github.com/
Username: perpil
Password:
Email: (this IS public) [email protected]
npm ERR! code E403
npm ERR! 403 403 Forbidden - PUT https://npm.pkg.github.com/-/user/org.couchdb.user:perpil - Permission denied
npm ERR! 403 In most cases, you or one of your dependencies are requesting
npm ERR! 403 a package version that is forbidden by your security policy, or
npm ERR! 403 on a server you do not have access to.

npm ERR! A complete log of this run can be found in:
npm ERR!     /Users/xxxxx/.npm/_logs/2023-01-03T18_29_48_236Z-debug-0.log

With read: packages and repo:* permissions

❯ npm login --scope=@winglang --registry=https://npm.pkg.github.com
npm WARN adduser `adduser` will be split into `login` and `register` in a future version. `adduser` will become an alias of `register`. `login` (currently an alias) will become its own command.
npm notice Log in on https://npm.pkg.github.com/
Username: perpil
Password:
Email: (this IS public) [email protected]
Logged in as perpil to scope @winglang on https://npm.pkg.github.com/.

When a user is land in docs.winglang.io he should not be able to see the docs, unless he was authorised and part of the contributors / maintainers github teams

General:

• switch back to docs.winglang.io
• remove the blog
• remove landing page

If user is not authenticated he should see:

• should redirect to auth0 authentication page

If he is already authenticated but not authorised (not part of contributors / maintainers) he should see:

• he should be redirected to https://winglang.typeform.com/to/xYJ3iQuC#github_username=<githu_username>

design required: @ekeren

• design for authenticated but not authorised

DOD for us:

• hosting is owed by us (monada
• embedded typeform
• analytics

DOD for monada:

• add cookie consent
• add the blog
• link to docs.winglang.io

I tried this

I've tried to run this:

npm run docs

Expected

A browser with a local instance of our docsite.

Instead, this happened

Browser tries to access:

https://undefined/authorize?redirect_uri=https%3A%2F%2Fundefined%2F&scope=openid%20profile%20email&...

Component

No response

Environment

- Wing Version:
- OS:
- Node version:

Anything else?

No response

I tried this

Go to https://docs.winglang.io and choose dark mode

Expected

The logo should adapt to dark mode

Instead, this happened

Component

Documentation

Environment

N/A

Anything else?

No response

The animation on winglang.io has a u after COUNTER_TABLE_NAME that appears near the end of the animation.

https://docusaurus.io/docs/search#using-algolia-docsearch

Currently this is our footer:

structure:

• Documentation
  • Getting started
  • Contributors Handbook
  • Language Reference
  • SDK Reference
• Get Help
  • github discussion
  • slack
  • stackoverflow
• Terms and Policies
  • Contributors terms of service
  • Contribution license

• Apply last comments by Adam
• Decide on title
• Add paragraph about Wing
• Last editorial review by Adam
• Publish to Medium

Description

We want our https://github.com/winglang/wing/tree/main/docs to have the following structure of empty docs who will later be created by @eladb (see winglang/website#66)

We also want to make sure that our docsite has the proper automation to copy the same structure and present it under winglang.io/docs right panel

structure:

• Introduction - content from README
  * Welcome
  * Rationale
• Getting started - content from README
  * Installation
  * Hello, Wing!
• FAQ (@revitalbarletz had started to collect a list of frequently asked questions. This is where we answer them)
  - Why did we create wing
  - What features are supported and not supported (roadmap)
• Language Reference - let's use the spec for now.
  • SDK Reference - output of jsii-docgen with tweaks for wingsdk.
  • CLI Reference - output of --help for now

DOD

winglang/wing:

• Add a job to wing release workflow to zip the docs directory content and add as an asset to the newly created release in github.

winglang/docsite:

• Create a workflow in docsite to pull new release docs and version number from winglang/wing
• fix current docs version (docusaurus command)
• extract zip to docs dir
• create new release (docusaurus command)
• issue new PR with the new content
• auto merge PR (P3)

In addition to the Wingly extracts, we'd like to create some more videos that are hard to do in that way.
We're not gonna invest a lot of resources in them, just pick low hanging fruit with high potential.

Some ideas:

• FAQ (some 20 questions and their answers. Film different people respond. Use materials in our documentation too)
• Short "Wing in 30 seconds" videos. Experiment with differnet styles and different messaging for different audiences. Use mainly VSC + Console screen recordings
• Short "Just wing it" videos. Show day to day struggles of cloud devs and then how we solve these pains with Wing

@ainvoner can we make sure we cover the basics here?
https://docusaurus.io/docs/seo

There is a bad link on the Strings section found here:

https://www.winglang.io/docs/language-reference#62-strings

String reference doc is available [here](https://www.winglang.io/docs/language-guide/language-reference#61-strings). Type of string is UTF-16 internally.
All string declaration variants are multi-line.

that link produces a 404.

I tried this

I want to be able to select the Wing version for the entire documentation site, not just the API reference.

Expected

I expect some kind of a global version selector:

Here's the one in the https://docusaurus.io/docs site:

Instead, this happened

I don't see any version selector, I just see some version numbers in the API reference.

Component

Documentation

Environment

N/A

Anything else?

No response

Not sure why, but once the docs site is loaded then a refresh results in a blank white page.

https://docs.winglang.io/reference/spec#1-general

Some trailing spaces are causing this.

We should check it on other files too.

DOD:

• public facing (status-ok) website that shows that winglag.io is up
• alert on winglang/wing#549 slack channel when the site is down
• alert on winglang/wing#549 slack channel when docs.winglang.io site is down

Summary

We need a first blog post

Feature Spec

It should lay the groundwork for wing.

Use Cases

No response

Implementation Notes

No response

Component

No response

I tried this

I am browsing through the documentation website, and clicking through the topics.

Expected

I expect the URLs of the pages to have a nice "sluggified" name, all lowercase. You know... good web style.

Something like:

• https://winglang.io/docs/getting-started/welcome
• https://winglang.io/docs/getting-started/rationale
• https://winglang.io/docs/introduction/installation

Instead, this happened

• https://winglang.io/docs/Getting%20Started/Welcome
• https://winglang.io/docs/Getting%20Started/Rationale
• https://winglang.io/docs/Introduction/Installation

Component

Documentation

Environment

- Wing Version:
- OS:
- Node version:

Anything else?

I think we need to make sure the id attribute in the docs are nice slugs.

We want our webpage to preset well when shared in social and for SEO

Resources:

• https://www.linkedin.com/pulse/10-most-important-meta-tags-you-need-know-seo-fardin-mahmud-/?trk=public_profile_article_view
• how to add to docusaurus

DOD:

• when our site is shared on twitter/linkedin/facebook it should look nice and to the point
• make sure that our winglang.io has the right preview
• make sure our specific blog has the right preview
• make sure our specific doc pages has the right preview

I tried this

When I go to docs.winglang.io

Expected

I expected to land here:

Instead, this happened

I see some kind of landing page:

Component

Documentation

Environment

N/A

Anything else?

No response

Currently when a user is authenticated in auth0 a hook in the login process checks Pipedrive for the user and, if in the proper invite stage of the deal, adds a Role to the user which is used in the docs site for authorization to the documentation.

However, based on this comment: https://monadahq.slack.com/archives/C04BG1M439S/p1668699517184039, the check should occur against Github and not Pipedrive, looking to see if the user is part of the Contributor group (or, more generally, has access to the repo).

https://docs.winglang.io/contributors/handbook currently leads to a 404. I believe it should redirect to https://docs.winglang.io/contributors

DOD:

• remove twitter link
• github links should go to winglang/wing

see https://winglang.slack.com/archives/C04LZ4UG3QE/p1685478989955829

Similar to the existing monitor for winglang.io

https://docusaurus.io/docs/sidebar/autogenerated#using-number-prefixes

We decided to use the doc site as our main site framework. The blog is already merged in there and we will put the landing page as well.

Please make sure it's password protected via Vercel.

@MarkMcCulloh wrote:

If it's worth rolling the blog into the docs site does it also make sense to roll the landing page into the docs site and just make winglang.io be the landing, docs, and blog site?

Yes I was thinking that too. Okay!

Let's make this what's behind winglang.io and use this framework for the entire site. Much simpler and cleaner!

Once we have the landing page artifacts I will add them to this repo (which we should rename winglang/website I guess)

Originally posted by @eladb in #55 (comment)

With this PR being merged and released as v0.16, the docs should be updated accordingly.

e.g. add_consumer but there are more occasions.

Happy to do it, just wasn't sure if that's on someone's plate already.

We only need the user name
Remove email

DOD:

• monada contribution term of service license
  • add https://docs.google.com/document/d/197EjBn-sqMjDR382vNLnGzhyBz_3Ysz-/edit to our docs
  • have a link from the README to the above page
• wing contribution
  • add https://docs.google.com/document/d/1N61jZ1bqKNV-BC0X_y3I3w6RCVaEwHE6/edit to our docs
  • add link from PR template to the above page

• when clicking on Tutorial the Docs link is set to 'active' as well

DOD:

• remove twitter link
• add latest version for doc only (if possible)
• github links should go to winglang/wing

Can't create a PR because forking is disabled.

has clodu target instead of cloud target

Cheers ✌️

we updated the default path to support single domain.
currently the vercel preview sites open with the default path "/" and that needs to be updated to "/docs"

We have a error in the console on winglang.io

We need to add a cookie consent since we are planning to install analytics on the website.

Auth0 requires an explicit definition of redirect urls during the signin process:

However, since every new branch of the docsite produces a new URL for the preview site, both auth0 needs to be updated to allow this redirect URL and the environment variables need to be updated on the preview to tell the site what the URL is that Vercel assigned to it. This makes previewing new builds too painful to set up.

There are three options I see:

1. Create a new branch called 'preview'. This will be a long-lived release branch alongside 'main'. anytime we want to preview a PR then it would be merged into 'preview'. This means the auth0 and Vercel setup for the 'preview' branch are one-time and static.
   Pros: One-time set up
   Cons: can't easily preview any PR, would have to merge to the 'preview' branch first. Could result in issues related to merging multiple things and adds more branch management work.

2. Create some hooks in Vercel that will update auth0 and vercel env variables on any new build.
   Pros: any branch is easily previewable without ugly branch management concerns
   Cons: up-front engineering work and a potentially long and ugly list of 'allowed callback urls' in auth0 which could be a pain to maintain properly.

3. Set up a special read of the environment and if we're in a 'preview' deployment then authentication is skipped all together.
   Pros: probably simple to implement.
   Cons: we remove the ability to test authentication concerns on preview builds.

Target date: 12/22/2022

Let's use this issue to track any issues we want to mention the Inflight Magazine. Just add comments here with any topic and @mbonig will pick this up from there.