Zuchka/add vale action #402
Conversation
|
might be best to wait on this until Melissa merges her overhaul... |
|
SO COOOOL. Agree on maybe waiting to merge until mine goes.. or maybe only merge the base of the Vale set up and not the fixes? or maybe it doesn't matter since I haven't made all of the big organization changes yet and could probably merge main into mine with minor conflict. I'm fine either way and excited to get this in |
| @@ -111,7 +111,7 @@ _Note, negations will only work if you include files in a preceding rule._ | |||
|
|
|||
| <PriorityBoardingBanner /> | |||
|
|
|||
| With Nixpacks, we analyze the app source directory and generate a build plan. This determines which language provider to install packages and runtimes for. | |||
| With Nixpacks, we analyze the app source directory and generate a build plan. This determines which language provider to install and the required packages and runtimes. | |||
There was a problem hiding this comment.
Loving this tool even more since it's flagging this. Although small nit, not sure about the suggested fix.. I don't think it reads like it's supposed to (yes using the same error in my comment lol). Curious about your thoughts.
| @@ -24,7 +24,7 @@ Railway follows a shared responsibility model for HIPAA compliance. Railway will | |||
|
|
|||
| If your company needs a BAA, you can contact our solutions team at [team@railway.app](mailto:team@railway.app). | |||
|
|
|||
| We are working on operationalized BAAs and continually gathering requirements for health focused workloads for Enterprises. You can subscribe to the road-map item and share your feedback on [our road-map board](https://railway.canny.io/feature-requests/p/compliance). | |||
| We are working on operationalized BAAs and continually gather requirements for health focused workloads on Enterprises. You can subscribe to the road-map item and share your feedback [here](https://railway.canny.io/feature-requests/p/compliance). | |||
There was a problem hiding this comment.
Similar here. I think it's a good flag, but not sure about the suggested fix. Maybe these are ones we override with our own fix and see if it passes on the next run?
|
|
||
| Companies choose Railway so that they can speed up their their development velocity while also maintaining their security and compliance posture. | ||
| Companies choose Railway to accelerate their development while also maintaining their security and compliance posture. |
| @@ -37,7 +37,7 @@ It's possible to go from zero → 3 services in < 30 seconds. Adding new service | |||
|
|
|||
| ### Pricing | |||
|
|
|||
| Pay only for what you use—no need to size dynos. | |||
| Pay only for what you use—no need to size (Dynos)[https://www.heroku.com/dynos]. | |||
There was a problem hiding this comment.
Holy moly no way! it detects external references and adds links 🤯
| @@ -40,14 +40,14 @@ To communicate with a service, you must bind to a IPv6 port and use the internal | |||
|
|
|||
| Railway uses the `*.railway.internal` domain for all internal DNS names. This domain will resolve to the internal IP address of the service. Within the service settings you can change the service name you can refer to but not the internal DNS root. Ex. `api-1.railway.internal` -> `api-2.railway.internal` | |||
|
|
|||
| Requests to replica DNS service address will be round robin'd between all replicas. | |||
| Requests to replicate DNS service addresses will use [a round-robin DNS](https://www.cloudflare.com/learning/dns/glossary/round-robin-dns/). | |||
There was a problem hiding this comment.
This one isn't right but understandably flagged
@melissa-hale agree! I will merge the GH action itself but not any of the edits. Once your overhaul is in we can re-assess :) |
This PR adds a very lightweight version of the Vale Github Action to the docs repo. A few things to note:
Valepackage and those check for pretty uncontroversial things: spelling errors, repeated words, stuff like that. The other one is a readability test that will output a readability score for the each page. I see this as a small foundation for building out our own house styleI'm excited to start building this out!